[GIT PULL] Documentation for 6.14

[GIT PULL] Documentation for 6.14

[Jonathan Corbet]

The following changes since commit d9339496729f1471b8dc326face17c4cf108b027:

  scripts/kernel-doc: Get -export option working again (2024-12-11 09:15:26 -0700)

are available in the Git repository at:

  git://git.lwn.net/linux.git tags/docs-6.14

for you to fetch changes up to 6912bdb7c676019b6dd4520f555079c4d3ab1bdb:

  Documentation: Fix x86_64 UEFI outdated references to elilo (2025-01-16 11:21:29 -0700)

----------------------------------------------------------------
Documentation changes this time around include:

- Quite a bit of Chinese and Spanish translation work.

- Clarifying that Git commit IDs >12chars are OK

- A new nvme-multipath document

- A reorganization of the admin-guide top-level page to make it readable

- Clarification of the role of Acked-by and maintainer discretion on their
  acceptance.

- Some reorganization of debugging-oriented docs.

...and typo fixes, documentation updates, etc. as usual.

----------------------------------------------------------------
Ahmad Fatoum (1):
      docs: process: submitting-patches: split canonical patch format section

Andrew Kreimer (1):
      Documentation/rv: Fix typos

Andy Shevchenko (3):
      x86/Documentation: Make Literal Blocks to follow reStructuredText specification
      x86/Documentation: Align Note Blocks style
      x86/Documentation: Elaborate Intel MID device list

Avadhut Naik (3):
      docs/sp_SP: Add translation of process/5.Posting.rst
      docs/sp_SP: Add translation of process/7.AdvancedTopics.rst
      docs/sp_SP: Add translation of process/8.Conclusion.rst

Bingwu Zhang (1):
      Documentation: filesystems: fix two misspells

Carlos Bilbao (4):
      docs/sp_SP: Add translation of process/3.Early-stage.rst
      docs/sp_SP: Add translation of process/4.Coding.rst
      docs/sp_SP: Add translation of process/6.Followthrough.rst
      docs/sp_SP: Move development-process to top of index

Carlos Maiolino (1):
      Documentation: Fix simple typo on filesystems/porting.rst

Cengiz Can (1):
      Documentation: remove :kyb: tags

Geert Uytterhoeven (2):
      Align git commit ID abbreviation guidelines and checks
      overlayfs.rst: Fix and improve grammar

Gianfranco Trad (1):
      Documentation: kvm: fix typo in api.rst

Greg Kroah-Hartman (1):
      Documentation: bug-hunting.rst: remove odd contact information

Guixin Liu (1):
      docs, nvme: introduce nvme-multipath document

I Hsin Cheng (1):
      docs/mm: Physical memory: Remove zone_t

Jonathan Corbet (4):
      Merge branch 'docs-fixes' into docs-mw
      docs: admin-guide: join the sysfs information in one place
      docs: admin-guide: add some subsection headings
      docs: admin-guide: bring some order to the "everything else" section

Li Zhijian (1):
      Documentation: Fix typo localmodonfig -> localmodconfig

Lubomir Rintel (1):
      Documentation/kernel-parameters: Fix a reference to vga-softcursor.rst

Matthew Wilcox (Oracle) (1):
      kref: Improve documentation

Michal Koutný (1):
      Documentation: sched/RT: Update paragraphs about RT bandwidth control

Miguel Ojeda (3):
      docs: submitting-patches: clarify Acked-by and introduce "# Suffix"
      docs: submitting-patches: clarify difference between Acked-by and Reviewed-by
      docs: submitting-patches: clarify that signers may use their discretion on tags

Nir Lichtman (1):
      Documentation: Fix x86_64 UEFI outdated references to elilo

Phil Auld (1):
      Documentation/sysctl: Add timer_migration to kernel.rst

Randy Dunlap (3):
      Documentation: core-api: add generic parser docbook
      docs: debugging: add more info about devcoredump
      Documentation: move dev-tools debugging files to process/debugging/

Ruffalo Lavoisier (1):
      docs: remove duplicate word

Saru2003 (2):
      Documentation/accounting: Fix typo in taskstats-struct.rst
      Documentation: zram: fix dictionary spelling

Shuo Zhao (2):
      docs/zh_CN: Add security digsig Chinese translation
      docs/zh_CN: Add security IMA-templates Chinese translation

Thorsten Leemhuis (1):
      docs: 5.Posting: mentioned Suggested-by: tag

Uwe Kleine-König (2):
      doc: module: Fix documented type of namespace
      doc: module: DEFAULT_SYMBOL_NAMESPACE must be defined before #includes

Vegard Nossum (1):
      scripts/kernel-doc: fix identifier parsing regex

Yuehui Zhao (2):
      docs/zh_CN: Add security index Chinese translation
      docs/zh_CN: Add security lsm Chinese translation

Yuxian Mao (1):
      docs/zh_CN: Add landlock index Chinese translation

zhangwei (2):
      docs/zh_CN: Add siphash index Chinese translation
      docs/zh_CN: Add sak index Chinese translation

 Documentation/accounting/taskstats-struct.rst      |   2 +-
 Documentation/admin-guide/README.rst               |   4 +-
 Documentation/admin-guide/blockdev/zram.rst        |   6 +-
 Documentation/admin-guide/braille-console.rst      |   4 +-
 Documentation/admin-guide/bug-hunting.rst          |   9 -
 Documentation/admin-guide/index.rst                | 162 ++++---
 Documentation/admin-guide/kernel-parameters.txt    |   2 +-
 Documentation/admin-guide/nvme-multipath.rst       |  72 ++++
 .../admin-guide/quickly-build-trimmed-linux.rst    |   2 +-
 Documentation/admin-guide/sysctl/fs.rst            |   2 +-
 Documentation/admin-guide/sysctl/kernel.rst        |   7 +
 Documentation/admin-guide/sysrq.rst                |  20 +-
 .../verify-bugs-and-bisect-regressions.rst         |   2 +-
 Documentation/arch/x86/boot.rst                    | 369 ++++++++--------
 Documentation/arch/x86/x86_64/uefi.rst             |  37 +-
 Documentation/core-api/index.rst                   |   1 +
 Documentation/core-api/kref.rst                    |   7 +-
 Documentation/core-api/parser.rst                  |  17 +
 Documentation/core-api/symbol-namespaces.rst       |  11 +-
 Documentation/dev-tools/index.rst                  |   5 +-
 Documentation/filesystems/iomap/operations.rst     |   2 +-
 Documentation/filesystems/overlayfs.rst            |   8 +-
 Documentation/filesystems/porting.rst              |   2 +-
 Documentation/mm/physical_memory.rst               |   2 +-
 Documentation/process/5.Posting.rst                |   4 +
 .../driver_development_debugging_guide.rst         |  20 +-
 .../debugging}/gdb-kernel-debugging.rst            |   0
 Documentation/process/debugging/index.rst          |   2 +
 .../{dev-tools => process/debugging}/kgdb.rst      |  50 +--
 Documentation/process/email-clients.rst            |   8 +-
 Documentation/process/maintainer-tip.rst           |   2 +-
 Documentation/process/submitting-patches.rst       |  86 ++--
 Documentation/scheduler/sched-deadline.rst         |  13 +-
 Documentation/scheduler/sched-ext.rst              |   6 +-
 Documentation/scheduler/sched-rt-group.rst         |   8 +-
 Documentation/trace/rv/runtime-verification.rst    |   4 +-
 .../translations/it_IT/process/email-clients.rst   |   8 +-
 .../translations/sp_SP/process/3.Early-stage.rst   | 234 ++++++++++-
 .../translations/sp_SP/process/4.Coding.rst        | 463 ++++++++++++++++++++-
 .../translations/sp_SP/process/5.Posting.rst       | 388 ++++++++++++++++-
 .../translations/sp_SP/process/6.Followthrough.rst | 223 +++++++++-
 .../sp_SP/process/7.AdvancedTopics.rst             | 207 ++++++++-
 .../translations/sp_SP/process/8.Conclusion.rst    |  75 +++-
 .../sp_SP/process/development-process.rst          |  21 +-
 .../translations/sp_SP/process/email-clients.rst   |   8 +-
 Documentation/translations/sp_SP/process/index.rst |   2 +-
 .../translations/zh_CN/admin-guide/bug-hunting.rst |   9 -
 .../translations/zh_CN/admin-guide/sysrq.rst       |  22 +-
 .../translations/zh_CN/process/email-clients.rst   |   8 +-
 .../translations/zh_CN/security/IMA-templates.rst  |  97 +++++
 .../translations/zh_CN/security/digsig.rst         | 103 +++++
 .../translations/zh_CN/security/index.rst          |  34 ++
 .../translations/zh_CN/security/landlock.rst       | 123 ++++++
 Documentation/translations/zh_CN/security/lsm.rst  |  95 +++++
 Documentation/translations/zh_CN/security/sak.rst  |  86 ++++
 .../translations/zh_CN/security/siphash.rst        | 195 +++++++++
 .../translations/zh_CN/subsystem-apis.rst          |   2 +-
 .../translations/zh_TW/admin-guide/bug-hunting.rst |  10 -
 .../translations/zh_TW/admin-guide/sysrq.rst       |  22 +-
 .../translations/zh_TW/process/email-clients.rst   |   8 +-
 Documentation/virt/kvm/api.rst                     |   2 +-
 MAINTAINERS                                        |   2 +-
 include/linux/kref.h                               |  48 ++-
 include/linux/tty_driver.h                         |   2 +-
 lib/Kconfig.debug                                  |   2 +-
 lib/Kconfig.kgdb                                   |   2 +-
 lib/parser.c                                       |   5 +-
 scripts/checkpatch.pl                              |   4 +-
 scripts/kernel-doc                                 |   2 +-
 69 files changed, 2992 insertions(+), 478 deletions(-)
 create mode 100644 Documentation/admin-guide/nvme-multipath.rst
 create mode 100644 Documentation/core-api/parser.rst
 rename Documentation/{dev-tools => process/debugging}/gdb-kernel-debugging.rst (100%)
 rename Documentation/{dev-tools => process/debugging}/kgdb.rst (96%)
 create mode 100644 Documentation/translations/zh_CN/security/IMA-templates.rst
 create mode 100644 Documentation/translations/zh_CN/security/digsig.rst
 create mode 100644 Documentation/translations/zh_CN/security/index.rst
 create mode 100644 Documentation/translations/zh_CN/security/landlock.rst
 create mode 100644 Documentation/translations/zh_CN/security/lsm.rst
 create mode 100644 Documentation/translations/zh_CN/security/sak.rst
 create mode 100644 Documentation/translations/zh_CN/security/siphash.rst

Re: [GIT PULL] Documentation for 6.14

[Linus Torvalds]

On Mon, 20 Jan 2025 at 11:48, Jonathan Corbet <corbet@lwn.net> wrote:
>
> - Clarifying that Git commit IDs >12chars are OK

Wel,, I'm not sure that was an improvement.

I'd rather not see stupid extra random characters.

We'll see. Hopefully people realize that "at least 12" means 12. Not
some random other number.

             Linus

Re: [GIT PULL] Documentation for 6.14

[pr-tracker-bot]

The pull request you sent on Mon, 20 Jan 2025 12:48:44 -0700:

> git://git.lwn.net/linux.git tags/docs-6.14

has been merged into torvalds/linux.git:
https://git.kernel.org/torvalds/c/d0f93ac2c384c40202cf393fa7e8a2cac7004ba1

Thank you!

-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/prtracker.html

Re: [GIT PULL] Documentation for 6.14

[Jonathan Corbet]

Linus Torvalds <torvalds@linuxfoundation.org> writes:

> On Mon, 20 Jan 2025 at 11:48, Jonathan Corbet <corbet@lwn.net> wrote:
>>
>> - Clarifying that Git commit IDs >12chars are OK
>
> Wel,, I'm not sure that was an improvement.
>
> I'd rather not see stupid extra random characters.
>
> We'll see. Hopefully people realize that "at least 12" means 12. Not
> some random other number.

I took it because it seemed that consistency in the documentation was
better than conflicting advice.  If the policy is really "exactly 12
characters", though, we should probably make it read that way
instead...?

jon

Re: [GIT PULL] Documentation for 6.14

[Linus Torvalds]

On Wed, 22 Jan 2025 at 05:58, Jonathan Corbet <corbet@lwn.net> wrote:
>
> I took it because it seemed that consistency in the documentation was
> better than conflicting advice.  If the policy is really "exactly 12
> characters", though, we should probably make it read that way
> instead...?

Well, I don't think it needs to be some hard "exactly 12". At some
point in the future, you *will* get collisions (Konstantin already
created a tree for that exact thing) and git will automatically give
you 13 or more characters.

But I also don't want to encourage people for no good reason to go
overboard, and we end up with extra line noise, and commit ID's that
don't line up nicely etc. The whole "12 characters isn't enough" isn't
actually the real and present problem we have (and there was a whole
long discussion about the things that _are_ problems).

                Linus