1. 19 Aug, 2018 9 commits
    • CODING_STYLE: Update section header format · ef76bc8a
      Tobin C. Harding authored
      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: 's avatarTobin C. Harding <me@tobin.cc>
    • CODING_STYLE: Fix non-uniform heading level · 4a79d662
      Tobin C. Harding authored
      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: 's avatarTobin C. Harding <me@tobin.cc>
    • CODING_STLYE: Remove sections implied by 'kernel style' · b10e84db
      Tobin C. Harding authored
      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: 's avatarTobin C. Harding <me@tobin.cc>
    • CODING_STLYE: Simplify explanation for use of 'extern' · 6d73cf92
      Tobin C. Harding authored
      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: 's avatarTobin C. Harding <me@tobin.cc>
    • CONTRIBUTING: Add 'be' to fix grammar · b8cbcaeb
      Tobin C. Harding authored
      Fix minor grammatical issue.
      Signed-off-by: 's avatarTobin C. Harding <me@tobin.cc>
    • CODING_STYLE: Mention kernel style in introduction · 5088a98f
      Tobin C. Harding authored
      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: 's avatarTobin C. Harding <me@tobin.cc>
    • CONTRIBUTING: Direct readers to CODING_STYLE.md · f02ddd08
      Tobin C. Harding authored
      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: 's avatarTobin C. Harding <me@tobin.cc>
    • CONTRIBUTING: Link to latest online kernel docs · a3a792c7
      Tobin C. Harding authored
      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: 's avatarTobin C. Harding <me@tobin.cc>
    • CONTRIBUTING: Update reference to kernel coding style · b914266c
      Tobin C. Harding authored
      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: 's avatarTobin C. Harding <me@tobin.cc>
  2. 16 Aug, 2018 11 commits
  3. 15 Aug, 2018 3 commits
  4. 14 Aug, 2018 4 commits
  5. 12 Aug, 2018 13 commits