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

Sun Aug 19 09:53:44 UTC 2018

  Branch: refs/heads/stable-3.0
  Home:   https://github.com/lxc/lxc
  Commit: b914266c76a0f3285f472d106f88bd383a5ade60
      https://github.com/lxc/lxc/commit/b914266c76a0f3285f472d106f88bd383a5ade60
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 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: a3a792c7291571ae8759576965ebe97bd42c3356
      https://github.com/lxc/lxc/commit/a3a792c7291571ae8759576965ebe97bd42c3356
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 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: f02ddd08d2869470d096ae57ec49fe383f58314f
      https://github.com/lxc/lxc/commit/f02ddd08d2869470d096ae57ec49fe383f58314f
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 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: 5088a98fd078af8d0cedffa9974c6872f84cac04
      https://github.com/lxc/lxc/commit/5088a98fd078af8d0cedffa9974c6872f84cac04
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 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: b8cbcaebf10f1b6811c7977cd80f3d045ab8518d
      https://github.com/lxc/lxc/commit/b8cbcaebf10f1b6811c7977cd80f3d045ab8518d
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 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: 6d73cf92dd698159fcc9387f405ae15b4ac1f95b
      https://github.com/lxc/lxc/commit/6d73cf92dd698159fcc9387f405ae15b4ac1f95b
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 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: b10e84db5524b7f68077eaafb67d7919cefd0be0
      https://github.com/lxc/lxc/commit/b10e84db5524b7f68077eaafb67d7919cefd0be0
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 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: 4a79d662dfcd08641251b54e684e59ffa268bf0f
      https://github.com/lxc/lxc/commit/4a79d662dfcd08641251b54e684e59ffa268bf0f
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 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: ef76bc8aabf44904df76304142fe54e7fc2649b9
      https://github.com/lxc/lxc/commit/ef76bc8aabf44904df76304142fe54e7fc2649b9
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 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: f15c45f588dd063bb31dd815ecbce9af736e724e
      https://github.com/lxc/lxc/commit/f15c45f588dd063bb31dd815ecbce9af736e724e
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/cmd/lxc_init.c

  Log Message:
  -----------
  cmd: Use parenthesis around complex macro

checkpatch emits error:

    ERROR: Macros with complex values should be enclosed in parentheses

Safeguard macro by use of parenthesis.

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

  Commit: 5d2a8f2e3f47439f90d42666f99940a5d7a9649f
      https://github.com/lxc/lxc/commit/5d2a8f2e3f47439f90d42666f99940a5d7a9649f
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/cmd/lxc_init.c

  Log Message:
  -----------
  cmd: Use 'void' instead of empty parameter list

checkpatch warns because of function definitions using empty parameter
list.  We should define these functions with 'void' as the parameter.

Use 'void' instead of empty parameter list for function definitions.

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

  Commit: 93dd6130f303f9011379b0c26b2e902a927531d2
      https://github.com/lxc/lxc/commit/93dd6130f303f9011379b0c26b2e902a927531d2
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/cmd/lxc_init.c

  Log Message:
  -----------
  cmd: Do not use braces for single statement block

checkpatch emites warning:

    WARNING: braces {} are not necessary for single statement blocks

Do not use braces for single statement block.

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

  Commit: 9c6ffb81622fcad98b9adc3f66643f7f5beeadf9
      https://github.com/lxc/lxc/commit/9c6ffb81622fcad98b9adc3f66643f7f5beeadf9
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/cmd/lxc_init.c
    M src/lxc/cmd/lxc_monitord.c
    M src/lxc/cmd/lxc_user_nic.c

  Log Message:
  -----------
  cmd: Fix whitespace issues

checkpatch warns about a bunch of whitespace issues.  Fix the
non-controversial ones.

Fix whitespace issues found by checkpatch.

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

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

  Changed paths:
    M src/lxc/cmd/lxc_init.c

  Log Message:
  -----------
  cmd: Use 'const' for static string constant.

checkpatch emits warning:

WARNING: static char array declaration should probably be static const char

Use 'const' for static string constant (array of chars).

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

  Commit: 6e0b4eda578a8fc10af04588ed523ebadbae311d
      https://github.com/lxc/lxc/commit/6e0b4eda578a8fc10af04588ed523ebadbae311d
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/cmd/lxc_init.c

  Log Message:
  -----------
  cmd: Remove unnecessary whitespace in string

checkpatch emits warning:

    WARNING: unnecessary whitespace before a quoted newline

Remove unnecessary whitespace before a quoted newline

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

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

  Changed paths:
    M src/lxc/cmd/lxc_user_nic.c

  Log Message:
  -----------
  cmd: Put trailing */ on a separate line

checkpatch emits warning:

    WARNING: Block comments use a trailing */ on a separate line

Put trailing */ on a separate line.

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

  Commit: 746eb137d0b0b64dc88bb765b174347285bf3570
      https://github.com/lxc/lxc/commit/746eb137d0b0b64dc88bb765b174347285bf3570
  Author: Tobin C. Harding <me at tobin.cc>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/cmd/lxc_user_nic.c

  Log Message:
  -----------
  cmd: Remove typo'd semicolon

checkpatch emits warning:

    WARNING: Statements terminations use 1 semicolon

Remove typo'd semicolon.

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

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

  Changed paths:
    M src/lxc/cmd/lxc_monitord.c
    M src/lxc/cmd/lxc_user_nic.c

  Log Message:
  -----------
  cmd: Do not use comparison to NULL

checkpatch emits two warnings of type:

    CHECK: Comparison to NULL could be written "!foo"

Prefer `(!foo)` instead of `(foo == NULL)`.

Do not use comparison to NULL, use !foo

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

  Commit: 4c61817d5412742a5c2bda65f4abfeca24fb414e
      https://github.com/lxc/lxc/commit/4c61817d5412742a5c2bda65f4abfeca24fb414e
  Author: Christian Brauner <christian.brauner at ubuntu.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/cmd/lxc_init.c

  Log Message:
  -----------
  lxc_init: s/SYSDEBUG()/SYSERROR()/g in remove_self

Since we switched to execveat() whenever possible in
commit 4b5b3a2a299b ("execute: use execveat() syscall if supported")
it is unlikely that remove_self() has any job to do at all. So dumb down the
error levels.

Closes #2536.

Signed-off-by: Christian Brauner <christian.brauner at ubuntu.com>

  Commit: e20cdd8751c2d35ae5766b7523c21194bc7fd43e
      https://github.com/lxc/lxc/commit/e20cdd8751c2d35ae5766b7523c21194bc7fd43e
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_attach.c

  Log Message:
  -----------
  tools: lxc-attach: add default log priority & cleanups

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: eda2d8560cc05163ca051984215dcfcf0cae6150
      https://github.com/lxc/lxc/commit/eda2d8560cc05163ca051984215dcfcf0cae6150
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_cgroup.c

  Log Message:
  -----------
  tools: lxc-cgroup: add default log priority & cleanups

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: 83a5624ac6108f2cdcb9bb80276ecc0352c2ba3c
      https://github.com/lxc/lxc/commit/83a5624ac6108f2cdcb9bb80276ecc0352c2ba3c
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_checkpoint.c

  Log Message:
  -----------
  tools: lxc-checkpoint: add default log priority & cleanups

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: d0e1b2576faefc07f7951cc49e64a3a0e3a70678
      https://github.com/lxc/lxc/commit/d0e1b2576faefc07f7951cc49e64a3a0e3a70678
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_console.c

  Log Message:
  -----------
  tools: lxc-console: add default log priority & cleanups

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: c141d4810cadcffe9104563ead85c63b53819898
      https://github.com/lxc/lxc/commit/c141d4810cadcffe9104563ead85c63b53819898
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_create.c

  Log Message:
  -----------
  tools: lxc-create: add default log priority & cleanups

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: a1fe06d6908f356357d7493d80d122e9adb3a68f
      https://github.com/lxc/lxc/commit/a1fe06d6908f356357d7493d80d122e9adb3a68f
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_destroy.c

  Log Message:
  -----------
  tools: lxc-destroy: add default log priority & cleanups

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: 3920d8745eb413e37657063e7e1437bf9384d642
      https://github.com/lxc/lxc/commit/3920d8745eb413e37657063e7e1437bf9384d642
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_device.c

  Log Message:
  -----------
  tools: lxc-device: add default log priority & cleanups

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: bb19d0ab6fbf59faaba9c7f43637429e04dc6adf
      https://github.com/lxc/lxc/commit/bb19d0ab6fbf59faaba9c7f43637429e04dc6adf
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_execute.c

  Log Message:
  -----------
  tools: lxc-execute: add default log priority & cleanups

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: 765604fab2c1d2e356ab7509a889dbffea02b957
      https://github.com/lxc/lxc/commit/765604fab2c1d2e356ab7509a889dbffea02b957
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_start.c

  Log Message:
  -----------
  tools: lxc-start: add default log priority & cleanups

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: 1e764f8083e5a26749b5fdff30ff9b96ad20a73a
      https://github.com/lxc/lxc/commit/1e764f8083e5a26749b5fdff30ff9b96ad20a73a
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_stop.c

  Log Message:
  -----------
  tools: lxc-stop: add default log priority & cleanups

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: 47d6b8f79037b7472154ab2cd143a39695c8ca43
      https://github.com/lxc/lxc/commit/47d6b8f79037b7472154ab2cd143a39695c8ca43
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_freeze.c

  Log Message:
  -----------
  tools: lxc-freeze: add default log priority & cleanups

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: 5dbf9d77224bbf40b913ff90e874016e8aac494f
      https://github.com/lxc/lxc/commit/5dbf9d77224bbf40b913ff90e874016e8aac494f
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_unfreeze.c

  Log Message:
  -----------
  tools: lxc-unfreeze: add default log priority & cleanups

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: 431ff1caa9ed53f0cca1526904a859bb0a37a6f2
      https://github.com/lxc/lxc/commit/431ff1caa9ed53f0cca1526904a859bb0a37a6f2
  Author: 2xsec <dh48.jeong at samsung.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/storage/storage_utils.c
    M src/lxc/storage/storage_utils.h
    M src/lxc/tools/lxc_copy.c
    M src/lxc/tools/lxc_create.c

  Log Message:
  -----------
  storage_utils: move duplicated function from tools

Signed-off-by: 2xsec <dh48.jeong at samsung.com>

  Commit: 56e193a6be7e06fd6fbce06512bdf954fc9cedbf
      https://github.com/lxc/lxc/commit/56e193a6be7e06fd6fbce06512bdf954fc9cedbf
  Author: Christian Brauner <christian.brauner at ubuntu.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/tools/lxc_execute.c

  Log Message:
  -----------
  tools: fix lxc-execute command parsing

Initialize buf to avoid parsing random data later on.

Signed-off-by: Christian Brauner <christian.brauner at ubuntu.com>

  Commit: 5b29b6a7b23a08144a237d218974febbd682fe91
      https://github.com/lxc/lxc/commit/5b29b6a7b23a08144a237d218974febbd682fe91
  Author: Lukasz Jagiello <lukasz at wikia-inc.com>
  Date:   2018-08-19 (Sun, 19 Aug 2018)

  Changed paths:
    M src/lxc/storage/loop.c

  Log Message:
  -----------
  lseek - integer overflow

The issue was introduced in PR (https://github.com/lxc/lxc/pull/1705):

Previous code:
```
  if (lseek(fd, size, SEEK_SET) < 0) {
    SYSERROR("Error seeking to set new loop file size");
    close(fd);
    return -1;
  }
```
New code:
```
  int fd, ret;

  [...]

  ret = lseek(fd, size, SEEK_SET);
  if (ret < 0) {
    SYSERROR("Failed to seek to set new loop file size for loop "
       "file \"%s\"", path);
    close(fd);
    return -1;
  }
```

Based on http://man7.org/linux/man-pages/man2/lseek.2.html:
> Upon successful completion, lseek() returns the resulting offset
> location as measured in bytes from the beginning of the file.

So in this case value of `size` and `size` is `uint64_t`.

This fix change declaration of `ret`, but it can be fixed in other ways.
Let me know what works for you.

This PR fix issues (https://github.com/lxc/lxc/issues/1872).

Signed-off-by: Lukasz Jagiello <lukasz at wikia-inc.com>

Compare: https://github.com/lxc/lxc/compare/56fb4efa7a2f...5b29b6a7b23a
      **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.