From a935ae071100d60f02c606bb208967e67ebb7b0a Mon Sep 17 00:00:00 2001 From: Rusty Russell Date: Thu, 15 Mar 2018 17:06:31 +1030 Subject: [PATCH] doc: Link STLYE.md from HACKING.md Signed-off-by: Rusty Russell --- doc/HACKING.md | 7 ++----- doc/STYLE.md | 5 ++++- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/HACKING.md b/doc/HACKING.md index 8f5205484..1d9a73a4a 100644 --- a/doc/HACKING.md +++ b/doc/HACKING.md @@ -11,11 +11,8 @@ It is designed to implement the lightning protocol as specified in Getting Started --------------- -It's in C, to encourage alternate implementations. -It uses the [Linux coding style][style]. -Patches are welcome! - -[style]: https://www.kernel.org/doc/html/v4.10/process/coding-style.html +It's in C, to encourage alternate implementations. Patches are welcome! +You should read our [Style Guide](STYLE.md). To read the code, you'll probably need to understand `ccan/tal`: it's a hierarchical memory allocator, where each allocation has a parent, and diff --git a/doc/STYLE.md b/doc/STYLE.md index 2082f20af..c473318cf 100644 --- a/doc/STYLE.md +++ b/doc/STYLE.md @@ -1,7 +1,10 @@ # Care And Feeding of Your Fellow Coders Style is an individualistic thing, but working on software is group -activity, so consistency is important. +activity, so consistency is important. Generally our coding style +is similar to the [Linux coding style][style]. + +[style]: https://www.kernel.org/doc/html/v4.10/process/coding-style.html ## Communication