diff options
| author | Daiki Ueno <ueno@gnu.org> | 2023-04-24 12:38:56 +0900 |
|---|---|---|
| committer | Daiki Ueno <ueno@gnu.org> | 2023-04-24 12:45:45 +0900 |
| commit | bc31d879a87cbae0e59227d4d814e92fb57dfada (patch) | |
| tree | 23f48dc0dac34f9349289422010e7bc7dab532f7 | |
| parent | 39fc5f3ef39dccd0eda8a1cb9233207860b143b2 (diff) | |
| download | gnutls-bc31d879a87cbae0e59227d4d814e92fb57dfada.tar.gz | |
doc: mention how to indent source code
Signed-off-by: Daiki Ueno <ueno@gnu.org>
| -rw-r--r-- | CONTRIBUTING.md | 4 | ||||
| -rw-r--r-- | doc/cha-support.texi | 9 |
2 files changed, 6 insertions, 7 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 37ee2e5e3f..d80580614f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,8 +66,8 @@ case by case basis. # Indentation style: - In general, use [the Linux kernel coding style](https://www.kernel.org/doc/html/latest/process/coding-style.html). -You may indent the source using GNU indent, e.g. "indent -linux *.c". + We use [the Linux kernel coding style](https://www.kernel.org/doc/html/latest/process/coding-style.html). You may indent the source using the +[devel/indent-gnutls](devel/indent-gnutls) script. # Commenting style diff --git a/doc/cha-support.texi b/doc/cha-support.texi index b68cd073f4..b34c776079 100644 --- a/doc/cha-support.texi +++ b/doc/cha-support.texi @@ -95,13 +95,12 @@ For code contributions, a number of style guides will help you: @itemize @bullet @item Coding Style. -Follow the GNU Standards document. -@c (@pxref{top, GNU Coding Standards,,standards}). +Follow the Linux kernel coding style@footnote{see @uref{https://www.kernel.org/doc/html/latest/process/coding-style.html}.}. If you normally code using another coding standard, there is no -problem, but you should use @samp{indent} to reformat the code -@c (@pxref{top, GNU Indent,, indent}) -before submitting your work. +problem, but you should run the @samp{indent-gnutls} script found in +the @samp{devel} directory to reformat the code before submitting your +work. @item Use the unified diff format @samp{diff -u}. |