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: NKonstantin Ryabitsev <konstantin@linuxfoundation.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add a file to the Documentation directory to describe how file licenses
should be described in all kernel files, using the SPDX identifier, as well
as where all licenses should be in the kernel source tree for people to
refer to (LICENSES/).

Thanks to Kate and Greg for review and editing and Jonas for the
suggestions concerning the meta tags in the licenses files.
Signed-off-by: NThomas Gleixner <tglx@linutronix.de>
Reviewed-by: NJonas Oberg <jonas@fsfe.org>
Reviewed-by: NJonathan Corbet <corbet@lwn.net>
Reviewed-by: NPhilippe Ombredanne <pombredanne@nexb.com>
Reviewed-by: NKate Stewart <kstewart@linuxfoundation.org>
Reviewed-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

add missing indent whitespace to list item, fixes the warning:

- process/submit-checklist.rst:41: WARNING: Enumerated list ends without a blank
  line; unexpected unindent.
Signed-off-by: NMarkus Heiser <markus.heiser@darmarit.de>
Reviewed-by: NDarren Hart (VMware) <dvhart@infradead.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Signed-off-by: NDavid Sterba <dsterba@suse.com>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add my name to the list.
Signed-off-by: NLuis R. Rodriguez <mcgrof@kernel.org>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add my name to the list.
Signed-off-by: NKees Cook <keescook@chromium.org>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add default value review to the submit checklist, referring to the
preference for "default n" from the previous patch added to
Documentation/kbuild/kconfig-language.txt.

Cc: "Yann E. MORIN" <yann.morin.1998@free.fr>
Cc: Masahiro Yamada <yamada.masahiro@socionext.com>
Cc: Michal Marek <mmarek@suse.com>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-kbuild@vger.kernel.org
Cc: linux-doc@vger.kernel.org
Signed-off-by: NDarren Hart (VMware) <dvhart@infradead.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add my name to the list.
Signed-off-by: NArnaldo Carvalho de Melo <acme@redhat.com>

Sometimes a single patch is the result of multiple authors.  As git only
can have one "author" of a patch, it is still good to properly give
credit to the other developers of a commit.  To address this, document
the "Co-Developed-by:" tag which can be used to show other authors of
the patch.

Note, these other authors must also provide a Signed-off-by: tag as it
is their work that is being submitted here.
Reported-by: NThomas Gleixner <tglx@linutronix.de>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Reviewed-by: NThomas Gleixner <tglx@linutronix.de>
Acked-by: NBorislav Petkov <bp@suse.de>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Add my name to the list.
Signed-off-by: NFrank Rowand <frank.rowand@sony.com>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

add me to the list.
Signed-off-by: NWilly Tarreau <w@1wt.eu>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

Add my name to the list.
Signed-off-by: NTim Bird <tim.bird@sony.com>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

The kernel enforcement statement commit had my Acked-by: but missed my
name in the document signatures.
Signed-off-by: NMartin K. Petersen <martin.petersen@oracle.com>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

Eduardo was not in the correct alphabetical order, and Ivan was somehow
listed twice, so fix these sorting issues up.
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

Adding a couple of names on behalf of Arm Ltd.
Acked-by: NMarc Zyngier <marc.zyngier@arm.com>
Signed-off-by: NCatalin Marinas <catalin.marinas@arm.com>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

Doc update because significance of corporate affiliation was unclear.
Acked-by: NDoug Ledford <dledford@redhat.com>
Acked-by: NPaolo Bonzini <pbonzini@redhat.com>
Acked-by: NHans de Goede <hdegoede@redhat.com>
Acked-by: NXin Long <lucien.xin@gmail.com>
Signed-off-by: NAndrea Arcangeli <aarcange@redhat.com>
Signed-off-by: NRichard Fontana <rfontana@redhat.com>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

I already Acked the patch, add my name to the list as well.
Signed-off-by: NLaura Abbott <laura@labbott.name>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

Add my name to the kernel enforcement statement as it is something I
support speaking on my own behalf and not a statement of my current
employer.
Signed-off-by: NDennis Dalessandro <dennis.dalessandro@intel.com>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

Signed-off-by: NTrond Myklebust <trond.myklebust@primarydata.com>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

Adding myself to the list as I missed the window to be in the original patch.

Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Bart Van Assche <bart.vanassche@wdc.com>
Cc: Namhyung Kim <namhyung@kernel.org>
Cc: Olof Johansson <olof@lixom.net>
Cc: Juergen Gross <jgross@suse.com>
Cc: Javier Martinez Canillas <javier@dowhile0.org>
Signed-off-by: NEduardo Valentin <eduval@amazon.com>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

Signed-off-by: NStephen Hemminger <sthemmin@microsoft.com>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

This adds a short document describing the views of how the Linux kernel
community feels about enforcing the license of the kernel.
Acked-by: NAl Viro <viro@zeniv.linux.org.uk>
Acked-by: NAlex Elder (Linaro) <elder@linaro.org>
Acked-by: NAndrea Arcangeli <aarcange@redhat.com>
Acked-by: NAndy Gross <andy.gross@linaro.org>
Acked-by: NAneesh Kumar K.V <aneesh.kumar@linux.vnet.ibm.com>
Acked-by: NAnna Schumaker <schumaker.anna@gmail.com>
Acked-by: NArd Biesheuvel <ardb@kernel.org>
Acked-by: NArnd Bergmann <arnd@arndb.de>
Acked-by: NArvind Yadav <arvind.yadav.cs@gmail.com>
Acked-by: NBart Van Assche <bart.vanassche@wdc.com>
Acked-by: NBhumika Goyal <bhumirks@gmail.com>
Acked-by: NBjorn Andersson <bjorn.andersson@linaro.org>
Acked-by: NBorislav Petkov <bp@suse.de>
Acked-by: NChristian Borntraeger <borntraeger@de.ibm.com>
Acked-by: NChristian König <christian.koenig@amd.com>
Acked-by: NChristophe JAILLET <christophe.jaillet@wanadoo.fr>
Acked-by: NChuck Lever <chuck.lever@oracle.com>
Acked-by: NColin Ian King <colin.king@canonical.com>
Acked-by: NDaniel Borkmann <daniel@iogearbox.net>
Acked-by: NDaniel Lezcano <daniel.lezcano@linaro.org>
Acked-by: NDaniel Vetter <daniel.vetter@ffwll.ch>
Acked-by: NDarrick J. Wong (Oracle) <darrick.wong@oracle.com>
Acked-by: NDarrick J. Wong <djwong@kernel.org>
Acked-by: NDavid Kershner <david.kershner@unisys.com>
Acked-by: NDavid S. Miller <davem@davemloft.net>
Acked-by: NDmitry Torokhov <dmitry.torokhov@gmail.com>
Acked-by: NDoug Ledford <dledford@redhat.com>
Acked-by: NFabio Estevam <festevam@gmail.com>
Acked-by: NFelipe Balbi <balbi@kernel.org>
Acked-by: NFlorian Westphal <fw@strlen.de>
Acked-by: NGeert Uytterhoeven <geert@linux-m68k.org>
Acked-by: NGuenter Roeck <linux@roeck-us.net>
Acked-by: NHannes Reinecke <hare@suse.com>
Acked-by: NHans de Goede <hdegoede@redhat.com>
Acked-by: NHeiko Carstens <heiko.carstens@de.ibm.com>
Acked-by: NHeiko Stuebner <heiko@sntech.de>
Acked-by: NHeiner Kallweit <hkallweit1@gmail.com>
Acked-by: NIngo Molnar <mingo@kernel.org>
Acked-by: NIvan Safonov <insafonov@gmail.com>
Acked-by: NJaegeuk Kim <jaegeuk@kernel.org>
Acked-by: NJan Kara (SUSE) <jack@suse.cz>
Acked-by: NJavier Martinez Canillas <javier@dowhile0.org>
Acked-by: NJeff Kirsher <jeffrey.t.kirsher@intel.com>
Acked-by: NJens Axboe <axboe@kernel.dk>
Acked-by: NJes Sorensen <Jes.Sorensen@gmail.com>
Acked-by: NJiri Kosina <jkosina@suse.cz>
Acked-by: NJiri Pirko <jiri@resnulli.us>
Acked-by: NJoe Perches <joe@perches.com>
Acked-by: NJoerg Roedel (SUSE) <jroedel@suse.de>
Acked-by: NJohan Hovold <johan@kernel.org>
Acked-by: NJosh Poimboeuf <jpoimboe@redhat.com>
Acked-by: NJuergen Gross <jgross@suse.com>
Acked-by: NJulia Lawall <Julia.Lawall@lip6.fr>
Acked-by: NK. Y. Srinivasan <kys@microsoft.com>
Acked-by: NKhalid Aziz <khalid@gonehiking.org>
Acked-by: NKrzysztof Kozlowski <krzk@kernel.org>
Acked-by: NKuninori Morimoto <kuninori.morimoto.gx@renesas.com>
Acked-by: NLarry Finger <Larry.Finger@lwfinger.net>
Acked-by: NLaura Abbott <laura@labbott.name>
Acked-by: NLee Jones <lee.jones@linaro.org>
Acked-by: NLeon Romanovsky <leon@kernel.org>
Acked-by: NLinus Walleij (Linaro) <linus.walleij@linaro.org>
Acked-by: NLv Zheng <zetalog@gmail.com>
Acked-by: NMartin K. Petersen (Oracle) <martin.petersen@oracle.com>
Acked-by: NMasahiro Yamada <yamada.masahiro@socionext.com>
Acked-by: NMasami Hiramatsu <mhiramat@kernel.org>
Acked-by: NMel Gorman <mgorman@suse.de>
Acked-by: NMichael S. Tsirkin <mst@redhat.com>
Acked-by: NMichal Hocko <mhocko@suse.com>
Acked-by: NMike Marshall <hubcap@omnibond.com>
Acked-by: NNamhyung Kim <namhyung@kernel.org>
Acked-by: NNeil Armstrong <narmstrong@baylibre.com>
Acked-by: NOlof Johansson <olof@lixom.net>
Acked-by: NPablo Neira Ayuso <pablo@netfilter.org>
Acked-by: NPaolo Bonzini <pbonzini@redhat.com>
Acked-by: NPaul Burton <paul.burton@mips.com>
Acked-by: NPaul E. McKenney <paulmck@linux.vnet.ibm.com>
Acked-by: NPeter Zijlstra <peterz@infradead.org>
Acked-by: NRafael J. Wysocki <rafael@kernel.org>
Acked-by: NRalf Baechle <ralf@linux-mips.org>
Acked-by: NRichard Weinberger <richard@nod.at>
Acked-by: NRik van Riel <riel@surriel.com>
Acked-by: NRob Clark <robdclark@gmail.com>
Acked-by: NRob Herring <robh@kernel.org>
Acked-by: NSebastian Reichel (Collabora) <sre@kernel.org>
Acked-by: NShawn Guo <shawnguo@kernel.org>
Acked-by: NShuah Khan <shuahkh@osg.samsung.com>
Acked-by: NSimon Horman <horms@verge.net.au>
Acked-by: NSrinivas Kandagatla <srinivas.kandagatla@linaro.org>
Acked-by: NSteven Rostedt (VMware) <rostedt@goodmis.org>
Acked-by: NSven Eckelmann <sven@narfation.org>
Acked-by: NTakashi Iwai (SUSE) <tiwai@suse.de>
Acked-by: NTejun Heo <tj@kernel.org>
Acked-by: NThierry Reding <thierry.reding@gmail.com>
Acked-by: NTony Luck <tony.luck@gmail.com>
Acked-by: NUlf Hansson <ulf.hansson@linaro.org>
Acked-by: NVinod Koul <vkoul@kernel.org>
Acked-by: NViresh Kumar <viresh.kumar@linaro.org>
Acked-by: NVivien Didelot <vivien.didelot@savoirfairelinux.com>
Acked-by: NWei Yongjun <weiyongjun1@huawei.com>
Acked-by: NXin Long <lucien.xin@gmail.com>
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>

Make driver-api document refs valid.
Signed-off-by: NTom Saeger <tom.saeger@oracle.com>
Acked-by: NRafael J. Wysocki <rafael.j.wysocki@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Way back in 2008 we didn't have "robust" in-kernel documentation system,
so the idea of putting something like the kernel driver statement in the
kernel tree wasn't even imagined.  But now that has changed, so add the
old document to the kernel source itself to allow for us to properly
reference it in one canonical place (as the LF wiki keeps moving things
around.)

This also will allow people to add their names to it, as I seem to have
lost the ability to do that by not knowing how to edit things on the
original document.
Signed-off-by: NGreg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: NMauro Carvalho Chehab <mchehab@kernel.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Devils in the details are found only when the high level design is
refined and gets more detailed, and the appropriate phrase to use to
describe this is "problems are revealed", not "problems are
reviewed".

Reviews may reveal these problems, though ;-)
Signed-off-by: NJunio C Hamano <gitster@pobox.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

There shouldn't be a blank line at the beginning, if there is no
optional in-body "From" line.  There must be a blank line between
the body of the explanation and the beginning of the S-o-b lines.
Signed-off-by: NJunio C Hamano <gitster@pobox.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Drop all references to git daily snapshots of Linux mainline git tree
since they are no longer generated.

Drop the "Last update" info since 'git log' is a better source of that
info and since the Last update date is not being updated.

Yes, I read that this file is obsolete, but it still has some useful
information in it.
Signed-off-by: NRandy Dunlap <rdunlap@infradead.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

git.kernel.org links don't work (fatal: repository ... not found).
Update them with the current style from https://git.kernel.org

There is no HTTP option, so also switch HTTP -> HTTPS.
Signed-off-by: NAndrii Bordunov <andrew.bordunov@gmail.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Documentation/process/submitting-patches.rst contains a non-ascii
character.  Change it to the ascii equivalent.
Signed-off-by: NFrank Rowand <frank.rowand@sony.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

The toolchain used by Sphinx is somewhat complex, and installing
it should be part of the doc-guide.

Move it out of changes.rst.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

The kfigure module doesn't work with Sphinx version 1.2. So,
update the minimal requirements accordingly.
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

Make thin archives build the default, but keep the config option
to allow exemptions if any breakage can't be quickly solved.
Signed-off-by: NNicholas Piggin <npiggin@gmail.com>
Signed-off-by: NMasahiro Yamada <yamada.masahiro@socionext.com>

IBM Verse is a web UI around Lotus Domino mail servers (much like
the Lotus Notes client talks to Domino servers).

For various reasons, it is not at all suitable for kernel development,
all of which have been raised (repeatedly) internally.
Signed-off-by: NStewart Smith <stewart@linux.vnet.ibm.com>
Acked-by: NSamuel Mendoza-Jonas <sam@mendozajonas.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

The "\n\t" sequence needs to be quoted or it will not render properly.

[jc: no signoff from the author, but it's trivial]
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

DocBook is mentioned several times at the documentation. Update
the obsolete references from it at the DocBook.
Acked-by: NSeongJae Park <sj38.park@gmail.com>
Signed-off-by: NMauro Carvalho Chehab <mchehab@s-opensource.com>

Commit 37d69ee3 ("docs: bump minimal GNU Make version to 3.81")
changes one entry of GNU make version in the changes.rst, there's still
one more entry saying that one need version 3.80.  Fix that.
Signed-off-by: NMax Filippov <jcmvbkbc@gmail.com>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

Since 2014, you can't successfully build kernels with GNU Make version
3.80. Example errors:

  $ git describe
  v4.11
  $ make --version | head -1
  GNU Make 3.80
  $ make defconfig
    HOSTCC  scripts/basic/fixdep
  scripts/Makefile.host:135: *** missing separator.  Stop.
  make: *** [defconfig] Error 2
  $ make ARCH=arm64 help
  arch/arm64/Makefile:43: *** unterminated call to function `warning': missing `)'.  Stop.
  $ make help >/dev/null
  ./Documentation/Makefile.sphinx:25: Extraneous text after `else' directive
  ./Documentation/Makefile.sphinx:31: *** only one `else' per conditional.  Stop.
  make: *** [help] Error 2

The first breakage was introduced by commit c8589d1e ("kbuild:
handle multi-objs dependency appropriately").  Since then (i.e. v3.18),
GNU Make 3.80 has not been able to compile the kernel, but nobody has
ever complained aboutt (or noticed) it.

Even GNU Make 3.81 is more than 10 years old.  It would not hurt to
match the documentation with reality instead of fixing makefiles.
Signed-off-by: NMasahiro Yamada <yamada.masahiro@socionext.com>
Signed-off-by: NLinus Torvalds <torvalds@linux-foundation.org>

In Documentation/process/4.Coding.rst there were a couple of paragraphs
that spilled over the 80 character line length. This was likely caused
when the document was converted to reStructuredText. Re-flow the
paragraphs and make the document references proper reStructuredText
:ref: links.

This also adds the appropriate reStructuredText file heading to
kernel-parameters.rst as referenced by the kernel-parameters link in
this patch.
Signed-off-by: NAndrew Clayton <andrew@digital-domain.net>
Reviewed-by: NJani Nikula <jani.nikula@intel.com>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>

A patch documenting how to specify which kernels a particular fix should
be backported to (seemingly) inadvertently added a minus sign after the
kernel version. This particular stable-tag format had never been used
prior to this patch, and was neither present when the patch in question
was first submitted (it was added in v2 without any comment).

Drop the minus sign to avoid any confusion.

Fixes: fdc81b79 ("stable_kernel_rules: Add clause about specification of kernel versions to patch.")
Signed-off-by: NJohan Hovold <johan@kernel.org>
Signed-off-by: NJonathan Corbet <corbet@lwn.net>