linux-toradex.git/Documentation/process/index.rst, branch v5.0

Merge tag 'compiler-attributes-for-linus-4.20-rc1' of https://github.com/ojeda/linux

2018-11-02T01:34:46+00:00

Pull compiler attribute updates from Miguel Ojeda:
 "This is an effort to disentangle the include/linux/compiler*.h headers
  and bring them up to date.

  The main idea behind the series is to use feature checking macros
  (i.e. __has_attribute) instead of compiler version checks (e.g.
  GCC_VERSION), which are compiler-agnostic (so they can be shared,
  reducing the size of compiler-specific headers) and version-agnostic.

  Other related improvements have been performed in the headers as well,
  which on top of the use of __has_attribute it has amounted to a
  significant simplification of these headers (e.g. GCC_VERSION is now
  only guarding a few non-attribute macros).

  This series should also help the efforts to support compiling the
  kernel with clang and icc. A fair amount of documentation and comments
  have also been added, clarified or removed; and the headers are now
  more readable, which should help kernel developers in general.

  The series was triggered due to the move to gcc >= 4.6. In turn, this
  series has also triggered Sparse to gain the ability to recognize
  __has_attribute on its own.

  Finally, the __nonstring variable attribute series has been also
  applied on top; plus two related patches from Nick Desaulniers for
  unreachable() that came a bit afterwards"

* tag 'compiler-attributes-for-linus-4.20-rc1' of https://github.com/ojeda/linux:
  compiler-gcc: remove comment about gcc 4.5 from unreachable()
  compiler.h: update definition of unreachable()
  Compiler Attributes: ext4: remove local __nonstring definition
  Compiler Attributes: auxdisplay: panel: use __nonstring
  Compiler Attributes: enable -Wstringop-truncation on W=1 (gcc >= 8)
  Compiler Attributes: add support for __nonstring (gcc >= 8)
  Compiler Attributes: add MAINTAINERS entry
  Compiler Attributes: add Doc/process/programming-language.rst
  Compiler Attributes: remove uses of __attribute__ from compiler.h
  Compiler Attributes: KENTRY used twice the "used" attribute
  Compiler Attributes: use feature checks instead of version checks
  Compiler Attributes: add missing SPDX ID in compiler_types.h
  Compiler Attributes: remove unneeded sparse (__CHECKER__) tests
  Compiler Attributes: homogenize __must_be_array
  Compiler Attributes: remove unneeded tests
  Compiler Attributes: always use the extra-underscores syntax
  Compiler Attributes: remove unused attributes

Merge tag 'docs-4.20' of git://git.lwn.net/linux

2018-10-24T17:01:11+00:00

Pull documentation updates from Jonathan Corbet:
 "This is a fairly typical cycle for documentation. There's some welcome
  readability improvements for the formatted output, some LICENSES
  updates including the addition of the ISC license, the removal of the
  unloved and unmaintained 00-INDEX files, the deprecated APIs document
  from Kees, more MM docs from Mike Rapoport, and the usual pile of typo
  fixes and corrections"

* tag 'docs-4.20' of git://git.lwn.net/linux: (41 commits)
  docs: Fix typos in histogram.rst
  docs: Introduce deprecated APIs list
  kernel-doc: fix declaration type determination
  doc: fix a typo in adding-syscalls.rst
  docs/admin-guide: memory-hotplug: remove table of contents
  doc: printk-formats: Remove bogus kobject references for device nodes
  Documentation: preempt-locking: Use better example
  dm flakey: Document "error_writes" feature
  docs/completion.txt: Fix a couple of punctuation nits
  LICENSES: Add ISC license text
  LICENSES: Add note to CDDL-1.0 license that it should not be used
  docs/core-api: memory-hotplug: add some details about locking internals
  docs/core-api: rename memory-hotplug-notifier to memory-hotplug
  docs: improve readability for people with poorer eyesight
  yama: clarify ptrace_scope=2 in Yama documentation
  docs/vm: split memory hotplug notifier description to Documentation/core-api
  docs: move memory hotplug description into admin-guide/mm
  doc: Fix acronym "FEKEK" in ecryptfs
  docs: fix some broken documentation references
  iommu: Fix passthrough option documentation
  ...

Code of Conduct Interpretation: Add document explaining how the Code of Conduct is to be interpreted

2018-10-22T06:33:35+00:00

The Contributor Covenant Code of Conduct is a general document meant to
provide a set of rules for almost any open source community.  Every
open-source community is unique and the Linux kernel is no exception.
Because of this, this document describes how we in the Linux kernel
community will interpret it.  We also do not expect this interpretation
to be static over time, and will adjust it as needed.

This document was created with the input and feedback of the TAB as well
as many current kernel maintainers.

Co-Developed-by: Thomas Gleixner 
Co-Developed-by: Olof Johansson 
Acked-by: Alex Deucher 
Acked-by: Alexei Starovoitov 
Acked-by: Amir Goldstein 
Acked-by: Andrew Morton 
Acked-by: Andy Lutomirski 
Acked-by: Anna-Maria Gleixner 
Acked-by: Ard Biesheuvel 
Acked-by: Benjamin Herrenschmidt 
Acked-by: Boris Brezillon 
Acked-by: Borislav Petkov 
Acked-by: Chris Mason 
Acked-by: Christian Lütke-Stetzkamp 
Acked-by: Colin Ian King 
Acked-by: Dan Carpenter 
Acked-by: Dan Williams 
Acked-by: Daniel Borkmann 
Acked-by: Daniel Vetter 
Acked-by: Dave Airlie 
Acked-by: Dave Hansen 
Acked-by: David Ahern 
Acked-by: David Sterba 
Acked-by: Dmitry Torokhov 
Acked-by: Dominik Brodowski 
Acked-by: Eric Dumazet 
Acked-by: Felipe Balbi 
Acked-by: Felix Kuehling 
Acked-by: Florian Fainelli 
Acked-by: Geert Uytterhoeven 
Acked-by: Grant Likely 
Acked-by: Gregory CLEMENT 
Acked-by: Guenter Roeck 
Acked-by: Gustavo A. R. Silva 
Acked-by: Hans Verkuil 
Acked-by: Hans de Goede 
Acked-by: Harry Wentland 
Acked-by: Heiko Stuebner 
Acked-by: Ingo Molnar 
Acked-by: Jaegeuk Kim 
Acked-by: James Smart 
Acked-by: James Smart 
Acked-by: Jan Kara 
Acked-by: Jani Nikula 
Acked-by: Jason A. Donenfeld 
Acked-by: Jeff Kirsher 
Acked-by: Jens Axboe 
Acked-by: Jessica Yu 
Acked-by: Jia-Ju Bai 
Acked-by: Jiri Kosina 
Acked-by: Jiri Olsa 
Acked-by: Joerg Roedel 
Acked-by: Johan Hovold 
Acked-by: Johannes Thumshirn 
Acked-by: Jonathan Corbet 
Acked-by: Julia Lawall 
Acked-by: Kees Cook 
Acked-by: Kirill Tkhai 
Acked-by: Kuninori Morimoto 
Acked-by: Laurent Pinchart 
Acked-by: Lina Iyer 
Acked-by: Linus Torvalds 
Acked-by: Linus Walleij 
Acked-by: Mark Brown 
Acked-by: Masahiro Yamada 
Acked-by: Masami Hiramatsu 
Acked-by: Mathieu Desnoyers 
Acked-by: Matias Bjørling 
Acked-by: Mauro Carvalho Chehab 
Acked-by: Maxime Ripard 
Acked-by: Michael Ellerman 
Acked-by: Mike Rapoport 
Acked-by: Mimi Zohar 
Acked-by: Miquel Raynal 
Acked-by: Mishi Choudhary 
Acked-by: Nikolay Borisov 
Acked-by: Oded Gabbay 
Acked-by: Palmer Dabbelt 
Acked-by: Paul E. McKenney 
Acked-by: Peter Zijlstra 
Acked-by: Rafael J. Wysocki 
Acked-by: Richard Weinberger 
Acked-by: Rik van Riel 
Acked-by: Rob Clark 
Acked-by: Rob Herring 
Acked-by: Rodrigo Vivi 
Acked-by: Sean Paul 
Acked-by: Sebastian Andrzej Siewior 
Acked-by: Sebastian Reichel 
Acked-by: Sergio Paracuellos 
Acked-by: Shawn Guo 
Acked-by: Shuah Khan 
Acked-by: Simon Horman 
Acked-by: Srinivas Kandagatla 
Acked-by: Stephen Hemminger 
Acked-by: Takashi Iwai 
Acked-by: Tejun Heo 
Acked-by: Theodore Ts'o 
Acked-by: Thierry Reding 
Acked-by: Todd Poynor 
Acked-by: Viresh Kumar 
Acked-by: Wei Yongjun 
Acked-by: YueHaibing 
Reviewed-by: Steven Rostedt 
Signed-off-by: Thomas Gleixner 
Signed-off-by: Olof Johansson 
Signed-off-by: Greg Kroah-Hartman

docs: Introduce deprecated APIs list

2018-10-18T18:22:43+00:00

As discussed in the "API replacement/deprecation" thread[1], this makes
an effort to document what things shouldn't get (re)added to the kernel,
by introducing Documentation/process/deprecated.rst.

[1] https://lists.linuxfoundation.org/pipermail/ksummit-discuss/2018-September/005282.html

Signed-off-by: Kees Cook 
Signed-off-by: Jonathan Corbet

Compiler Attributes: add Doc/process/programming-language.rst

2018-09-30T18:14:04+00:00

Tested-by: Sedat Dilek  # on top of v4.19-rc5, clang 7
Reviewed-by: Nick Desaulniers 
Reviewed-by: Luc Van Oostenryck 
Signed-off-by: Miguel Ojeda

Code of Conduct: Let's revamp it.

2018-09-16T18:42:28+00:00

The Code of Conflict is not achieving its implicit goal of fostering
civility and the spirit of 'be excellent to each other'.  Explicit
guidelines have demonstrated success in other projects and other areas
of the kernel.

Here is a Code of Conduct statement for the wider kernel.  It is based
on the Contributor Covenant as described at www.contributor-covenant.org

From this point forward, we should abide by these rules in order to help
make the kernel community a welcoming environment to participate in.

Signed-off-by: Chris Mason 
Signed-off-by: Dan Williams 
Signed-off-by: Jonathan Corbet 
Signed-off-by: Olof Johansson 
Signed-off-by: Steven Rostedt (VMware) 
Signed-off-by: Greg Kroah-Hartman 
Signed-off-by: Linus Torvalds

docs: tidy up TOCs and refs to license-rules.rst

2018-08-31T22:50:50+00:00

The documentation and TOCs are organized in a manner of a tree. Adding a TOC to
the root, which refers to a file which is located in a subfolder forms a
grid. Those TOCs are a bit confusing and thats why we get additional error
messages while building partial documentation::

  $ make SPHINXDIRS=process htmldocs
  ...
  checking consistency... Documentation/process/license-rules.rst: \
  WARNING: document isn't included in any toctree

To fix it, the *root-license-TOC* is replaced by a reference and the
'license-roles.txt' is added to the Documentation/process/index.rst TOC.

BTW: there was an old licences remark in Documentation/process/howto.rst which
is also updated, mentioning SPDX and pointing to the license-rules.rst

Signed-off-by: Markus Heiser 
Signed-off-by: Jonathan Corbet

docs: */index.rst: Add newer documents to their respective index.rst

2018-05-08T15:57:35+00:00

A number of new docs were added, but they're currently not on
the index.rst from the session they're supposed to be, causing
Sphinx warnings.

Add them.

Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet

Documentation/process: kernel maintainer PGP guide

2018-02-01T17:58:19+00:00

This guide is an adapted version of the more general "Protecting Code
Integrity" guide written and maintained by The Linux Foundation IT for
use with open-source projects. It provides the oft-lacking guidance on
the following topics:

- how to properly protect one's PGP keys to minimize the risks of them
  being stolen and used maliciously to impersonate a kernel developer
- how to configure Git to properly use GnuPG
- when and how to use PGP with Git
- how to verify fellow Linux Kernel developer identities

I believe this document should live with the rest of the documentation
describing proper processes one should follow when participating in
kernel development. Placing it in a wiki on some place like kernel.org
would be insufficient for a number of reasons -- primarily, because only
a relatively small subset of maintainers have accounts on kernel.org,
but also because even those who do rarely remember that such wiki
exists. Keeping it with the rest of in-kernel docs should hopefully give
it more visibility, but also help keep it up-to-date as tools and
processes evolve.

Signed-off-by: Konstantin Ryabitsev 
Signed-off-by: Jonathan Corbet

Merge tag 'docs-4.15' of git://git.lwn.net/linux

2017-11-13T16:25:06+00:00

Pull documentation updates from Jonathan Corbet:
 "A relatively calm cycle for the docs tree again.

  - The old driver statement has been added to the kernel docs.

  - We have a couple of new helper scripts. find-unused-docs.sh from
    Sayli Karnic will point out kerneldoc comments that are not actually
    used in the documentation. Jani Nikula's
    documentation-file-ref-check finds references to non-existing files.

  - A new ftrace document from Steve Rostedt.

  - Vinod Koul converted the dmaengine docs to RST

  Beyond that, it's mostly simple fixes.

  This set reaches outside of Documentation/ a bit more than most. In
  all cases, the changes are to comment docs, mostly from Randy, in
  places where there didn't seem to be anybody better to take them"

* tag 'docs-4.15' of git://git.lwn.net/linux: (52 commits)
  documentation: fb: update list of available compiled-in fonts
  MAINTAINERS: update DMAengine documentation location
  dmaengine: doc: ReSTize pxa_dma doc
  dmaengine: doc: ReSTize dmatest doc
  dmaengine: doc: ReSTize client API doc
  dmaengine: doc: ReSTize provider doc
  dmaengine: doc: Add ReST style dmaengine document
  ftrace/docs: Add documentation on how to use ftrace from within the kernel
  bug-hunting.rst: Fix an example and a typo in a Sphinx tag
  scripts: Add a script to find unused documentation
  samples: Convert timers to use timer_setup()
  documentation: kernel-api: add more info on bitmap functions
  Documentation: fix selftests related file refs
  Documentation: fix ref to power basic-pm-debugging
  Documentation: fix ref to trace stm content
  Documentation: fix ref to coccinelle content
  Documentation: fix ref to workqueue content
  Documentation: fix ref to sphinx/kerneldoc.py
  Documentation: fix locking rt-mutex doc refs
  docs: dev-tools: correct Coccinelle version number
  ...