[lxc-devel] [lxc/lxc] 82778d: CONTRIBUTING: Update reference to kernel coding st...

Fri Aug 17 09:27:24 UTC 2018

  Branch: refs/heads/master
  Home:   https://github.com/lxc/lxc
  Commit: 82778d4134d22c4ee1cb5de04152e46b1b6ecebe
      https://github.com/lxc/lxc/commit/82778d4134d22c4ee1cb5de04152e46b1b6ecebe
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-17 (Fri, 17 Aug 2018)

  Changed paths:
    M CONTRIBUTING

  Log Message:
  -----------
  CONTRIBUTING: Update reference to kernel coding style

Kernel coding style guide filename is stale, this file has been renamed
in the kernel tree.  While this file still exists we should use the new
filename.

Update reference to kernel coding style guide to use the new file name.

Signed-off-by: Tobin C. Harding <me at tobin.cc>

  Commit: b6fbcbbb81558b75ccb22f75209ef36c190a9595
      https://github.com/lxc/lxc/commit/b6fbcbbb81558b75ccb22f75209ef36c190a9595
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-17 (Fri, 17 Aug 2018)

  Changed paths:
    M CONTRIBUTING

  Log Message:
  -----------
  CONTRIBUTING: Link to latest online kernel docs

Currently we link to a URL for v4.10 of the kernel docs.  Since we
already mention the kernel tree we should link to the _latest_ kernel
docs online instead of a fixed past version.

Link to latest online kernel docs tracking the mainline instead of past
fixed version.

Signed-off-by: Tobin C. Harding <me at tobin.cc>

  Commit: 54df5d72edcbed115273c6ce3e8f963d9386f248
      https://github.com/lxc/lxc/commit/54df5d72edcbed115273c6ce3e8f963d9386f248
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-17 (Fri, 17 Aug 2018)

  Changed paths:
    M CONTRIBUTING

  Log Message:
  -----------
  CONTRIBUTING: Direct readers to CODING_STYLE.md

Currently the 'Coding Style' section mentions only the kernel coding
style.  We have additions on top on this outlined in CODING_STYLE.md.
We should direct readers to this document as well as the kernel docs.

Direct readers to CODING_STLYE.md in the 'Coding Style' section.

Signed-off-by: Tobin C. Harding <me at tobin.cc>

  Commit: 183d7fa5ce9135be07e057ac6b000fec536285f9
      https://github.com/lxc/lxc/commit/183d7fa5ce9135be07e057ac6b000fec536285f9
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-17 (Fri, 17 Aug 2018)

  Changed paths:
    M CODING_STYLE.md

  Log Message:
  -----------
  CODING_STYLE: Mention kernel style in introduction

Currently the coding style guide does not mention that we use kernel
coding style as a base style for LXC.  We have just linked to
CODING_STLYE.md from CONTRIBUTING (which mentions use of kernel coding
style).  We can increase documentation congruence and completeness by
mentioning kernel coding style guide in the introduction to our style
guide.

Add heading and introduction to coding style guide informing readers
that we follow kernel coding style as a base before explaining our style
additions.

Signed-off-by: Tobin C. Harding <me at tobin.cc>

  Commit: cd15ab7a04e03c9af0c07b9d8cf0942d1ab1932a
      https://github.com/lxc/lxc/commit/cd15ab7a04e03c9af0c07b9d8cf0942d1ab1932a
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-17 (Fri, 17 Aug 2018)

  Changed paths:
    M CONTRIBUTING

  Log Message:
  -----------
  CONTRIBUTING: Add 'be' to fix grammar

Fix minor grammatical issue.

Signed-off-by: Tobin C. Harding <me at tobin.cc>

  Commit: 39a1e1fa19914f6ae7d595c5fb8fd7eb636dcbdc
      https://github.com/lxc/lxc/commit/39a1e1fa19914f6ae7d595c5fb8fd7eb636dcbdc
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-17 (Fri, 17 Aug 2018)

  Changed paths:
    M CODING_STYLE.md

  Log Message:
  -----------
  CODING_STLYE: Simplify explanation for use of 'extern'

Current explanation of rules around usage of 'extern' are overly
verbose.  It is not necessary to state that functions should be declared
in header files, the compiler already enforces this.  These rules are
simple, they are better described with simple statements.  An example is
not necessary for such simple rules and serves only to make the document
longer.

Use two simple statements describing the rules that govern function
declaration and the usage of the 'extern' keyword.

Signed-off-by: Tobin C. Harding <me at tobin.cc>

  Commit: 524440e920df1fc0b1839178fc391c1bf7f90b3c
      https://github.com/lxc/lxc/commit/524440e920df1fc0b1839178fc391c1bf7f90b3c
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-17 (Fri, 17 Aug 2018)

  Changed paths:
    M CODING_STYLE.md

  Log Message:
  -----------
  CODING_STLYE: Remove sections implied by 'kernel style'

We explicitly state that LXC uses coding style based on Linux kernel
style.  It is redundant to then document obvious, and well known, kernel
style rules.  Identifier names certainly fall into this category as does
usage of braces.

Remove sections implied by 'kernel style'.  Naming conventions and brace
placement conventions.

Signed-off-by: Tobin C. Harding <me at tobin.cc>

  Commit: efcb7f361beefbdb1c24ad86c75c2ed468f29c90
      https://github.com/lxc/lxc/commit/efcb7f361beefbdb1c24ad86c75c2ed468f29c90
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-17 (Fri, 17 Aug 2018)

  Changed paths:
    M CODING_STYLE.md

  Log Message:
  -----------
  CODING_STYLE: Fix non-uniform heading level

Heading uses only 3 level header (###) but the rest of the file uses
four (####).  We should be uniform.

Use uniform heading level in line with the rest of the file.

Signed-off-by: Tobin C. Harding <me at tobin.cc>

  Commit: 7419c83f441b61061f3056f4453b8ddefccef764
      https://github.com/lxc/lxc/commit/7419c83f441b61061f3056f4453b8ddefccef764
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-17 (Fri, 17 Aug 2018)

  Changed paths:
    M CODING_STYLE.md

  Log Message:
  -----------
  CODING_STYLE: Update section header format

Currently for section headings we use fourth level markdown heading
level (####).  We do not have levels two or three.

We can use standard incremental levels for heading adornments i.e

1) =========
2) ##
3) ###
ect.

Since this document is likely referenced by maintainers when guiding new
contributors it can save maintainer time to be able to quickly reference
a section in the coding stlye guide.  If we add numbers to each heading
(like the kernel stlye guide) then maintainers can say:

   Nice patch, please see section 3 of the coding style guide and ...

So, this patch makes two changes

- Use incremental level heading adornments
- Add a number to each section heading

Signed-off-by: Tobin C. Harding <me at tobin.cc>

  Commit: 5246e140b8dc4116f6e3650cf9bf52b0f93b5c05
      https://github.com/lxc/lxc/commit/5246e140b8dc4116f6e3650cf9bf52b0f93b5c05
  Author: Christian Brauner <christian at brauner.io>
  Date:   2018-08-17 (Fri, 17 Aug 2018)

  Changed paths:
    M CODING_STYLE.md
    M CONTRIBUTING

  Log Message:
  -----------
  Merge pull request #2539 from tcharding/contributing

Clean up contributing and coding stlye docs

Compare: https://github.com/lxc/lxc/compare/d1bf8af11be8...5246e140b8dc
      **NOTE:** This service has been marked for deprecation: https://developer.github.com/changes/2018-04-25-github-services-deprecation/

      Functionality will be removed from GitHub.com on January 31st, 2019.