linux.git/Documentation/process, branch v5.16-rc2

Documentation/process: fix a cross reference

2021-11-17T13:12:14+00:00

The cross-reference for the handbooks section works. However, it is
meant to describe the path inside the Kernel's doc where the section
is, but there's an space instead of a dash, plus it lacks the .rst at
the end, which makes:

	./scripts/documentation-file-ref-check

to complain.

Fixes: 604370e106cc ("Documentation/process: Add maintainer handbooks section")
Signed-off-by: Mauro Carvalho Chehab 
Signed-off-by: Jonathan Corbet

docs: Update Sphinx requirements

2021-11-15T09:47:22+00:00

Commit f546ff0c0c07 ("Move our minimum Sphinx version to 1.7") raised
the minimum version to 1.7.

For pdfdocs, sphinx_pre_install says:

    note: If you want pdf, you need at least Sphinx 2.4.4.

, and current requirements.txt installs Sphinx 2.4.4.

Update Sphinx versions mentioned in docs and remove a note on earlier
Sphinx versions.

Update zh_CN and it_IT translations as well.

Signed-off-by: Akira Yokosawa 
Cc: Federico Vaga 
Cc: Alex Shi 
Reviewed-by: Alex Shi 
Signed-off-by: Jonathan Corbet

docs: submitting-patches: make section about the Link: tag more explicit

2021-10-28T19:53:47+00:00

Mention the 'Link' tag in the section about adding URLs to the commit
msg, to make it clearer they "_primarily_ [...] should be about
background", as Linus recently stated (see the link below). That makes
the explanation also easier to find with a text search. For the same
reason and to improve comprehensibility provide an example, too.

Slightly improve the text at the same time to make it more obvious
developers are meant to add links to issue reports in mailing list
archives, as those allow regression tracking efforts to automatically
check which bugs got resolved.

Move the section also downwards slightly, to reduce jumping back and
forth between aspects relevant for the top and the bottom part of the
commit msg.

Link: https://lore.kernel.org/lkml/CAHk-=wgBhyLhQLPem1vybKNt7BKP+=qF=veBgc7VirZaXn4FUw@mail.gmail.com/
CC: Konstantin Ryabitsev 
Signed-off-by: Thorsten Leemhuis 
Reviewed-by: Konstantin Ryabitsev 
Link: https://lore.kernel.org/r/27105768dc19b395e7c8e7a80d056d1ff9c570d0.1635152553.git.linux@leemhuis.info
[jc: tweaked wording following Konstantin's recommendation]
Signed-off-by: Jonathan Corbet

docs: deprecated.rst: Clarify open-coded arithmetic with literals

2021-10-26T15:43:54+00:00

Although using literals for size calculation in allocator arguments may
be harmless due to compiler warnings in case of overflows, it is better
to refactor the code to avoid the use of open-coded arithmetic.

So, clarify the preferred way in these cases.

Suggested-by: Kees Cook 
Signed-off-by: Len Baker 
Reviewed-by: Gustavo A. R. Silva 
Link: https://lore.kernel.org/r/20210925143455.21221-1-len.baker@gmx.com
Signed-off-by: Jonathan Corbet

coding-style.rst: trivial: fix location of driver model macros

2021-10-26T15:39:49+00:00

The dev_printk()-like functions moved to include/linux/dev_print.h in
commit af628aae8640 ("device.h: move dev_printk()-like functions to
dev_printk.h").

Signed-off-by: Trevor Woerner 
Reviewed-by: Shuah Khan 
Reviewed-by: Miguel Ojeda 
Link: https://lore.kernel.org/r/20210423184012.39300-1-twoerner@gmail.com
Signed-off-by: Jonathan Corbet

docs: use the lore redirector everywhere

2021-10-12T19:58:19+00:00

Change all links from using the lkml redirector to the lore redirector,
as the kernel.org admin recently indicated: we shouldn't be using
lkml.kernel.org anymore because the domain can create confusion, as it
indicates it is only valid for messages sent to the LKML; the convention
has been to use https://lore.kernel.org/r/msgid for this reason.

In this process also change three links from using http to https.

Link: https://lore.kernel.org/r/20211006170025.qw3glxvocczfuhar@meerkat.local
CC: Thomas Gleixner 
CC: Ingo Molnar 
CC: Borislav Petkov 
CC: Hu Haowen 
CC: Alex Shi 
CC: Federico Vaga 
Signed-off-by: Thorsten Leemhuis 
Reviewed-by: Konstantin Ryabitsev 
Link: https://lore.kernel.org/r/5bb55bac6ba10fafab19bf2b21572dd0e2f8cea2.1633593385.git.linux@leemhuis.info
Signed-off-by: Jonathan Corbet

docs: update file link location

2021-10-12T19:49:27+00:00

Fix web error: this site can't be reached

Signed-off-by: Tommaso Merciai 
Link: https://lore.kernel.org/r/20211003220706.7784-1-tomm.merciai@gmail.com
Signed-off-by: Jonathan Corbet

docs: Explain the desired position of function attributes

2021-10-12T19:35:02+00:00

While discussing how to format the addition of various function
attributes, some "unwritten rules" of ordering surfaced[1]. Capture as
close as possible to Linus's preferences for future reference.

(Though I note the dissent voiced by Joe Perches, Alexey Dobriyan, and
others that would prefer all attributes live on a separate leading line.)

[1] https://lore.kernel.org/mm-commits/CAHk-=wiOCLRny5aifWNhr621kYrJwhfURsa0vFPeUEm8mF0ufg@mail.gmail.com/

Signed-off-by: Kees Cook 
Link: https://lore.kernel.org/r/20211005152611.4120605-1-keescook@chromium.org
Signed-off-by: Jonathan Corbet

Merge tag 'v5.15-rc4' into docs-next

2021-10-04T22:44:16+00:00

This is needed to get a docs fix that entered via the DRM tree; testers
have requested it so that PDF builds in docs-next work again.

Documentation/process: Add tip tree handbook

2021-09-14T20:46:49+00:00

Add a document to the subsystem/maintainer handbook section, which explains
what the tip tree is, how it operates and what rules and expectations it
has.

  [ bp:

   - Add a SPDX identifier, work in most comments from the thread.
   - 9bf19b78a203 ("Documentation/submitting-patches: Document the SoB
     chain") is also in the main Documentation but I'm leaving the
     paragraph here because it has the proper structure - text talks about
     SoBs and referencing somewhere else would interrupt the flow.
   - Move backtraces in changelogs to main submitting-patches.rst.
   - "Patch version information" is explained to a great detail in
     submitting-patches.rst too.
   - Hyperlink resend reminders section.
  ]

Signed-off-by: Thomas Gleixner 
Signed-off-by: Borislav Petkov 
Reviewed-by: Paul E. McKenney 
Link: https://lkml.kernel.org/r/20181107171149.165693799@linutronix.de
Link: https://lore.kernel.org/r/20210913153942.15251-3-bp@alien8.de
Signed-off-by: Jonathan Corbet