History log of /linux/README (Results 1 – 25 of 50)
Revision Date Author Comments
# 78d979db 23-Dec-2025 Sasha Levin <sashal@kernel.org>

docs: add AI Coding Assistants documentation

Add guidance for AI assistants and developers using AI tools for kernel
contributions, per the consensus reached at the 2025 Maintainers Summit.

Create

docs: add AI Coding Assistants documentation

Add guidance for AI assistants and developers using AI tools for kernel
contributions, per the consensus reached at the 2025 Maintainers Summit.

Create Documentation/process/coding-assistants.rst with detailed guidance
on licensing, Signed-off-by requirements, and attribution format. The
README points AI tools to this documentation.

This will allow coding assistants to easily parse these instructions and
comply with guidelines set by the community.

Link: https://lwn.net/Articles/1049830/
Signed-off-by: Sasha Levin <sashal@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251223122110.2496946-1-sashal@kernel.org>

show more ...


# b9a565b3 21-Nov-2025 Sasha Levin <sashal@kernel.org>

README: restructure with role-based documentation and guidelines

Reorganize README to provide targeted documentation paths for different user
roles including developers, researchers, security expert

README: restructure with role-based documentation and guidelines

Reorganize README to provide targeted documentation paths for different user
roles including developers, researchers, security experts, and maintainers.

Add quick start section and essential docs links.

Signed-off-by: Sasha Levin <sashal@kernel.org>
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Reviewed-by: Kees Cook <kees@kernel.org>
Reviewed-by: SeongJae Park <sj@kernel.org>
Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20251121180009.2634393-1-sashal@kernel.org>

show more ...


# bf4401f3 13-Mar-2024 Maki Hatano <maki.y.hatano@gmail.com>

README: Fix spelling

- ReStructured Text should be exactly reStructuredText
- "reStructuredText" is ONE word, not two! according to https://docutils.sourceforge.io/rst.html

Signed-off-by: Maki Hata

README: Fix spelling

- ReStructured Text should be exactly reStructuredText
- "reStructuredText" is ONE word, not two! according to https://docutils.sourceforge.io/rst.html

Signed-off-by: Maki Hatano <Maki.Y.Hatano@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <20240313100136.20424-1-Maki.Y.Hatano@gmail.com>

show more ...


# 693fe595 07-Feb-2024 Thorsten Blum <thorsten.blum@toblux.com>

README: Fix spelling/capitalization

- Fix spelling/capitalization s/Restructured/ReStructured/

Signed-off-by: Thorsten Blum <thorsten.blum@toblux.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net

README: Fix spelling/capitalization

- Fix spelling/capitalization s/Restructured/ReStructured/

Signed-off-by: Thorsten Blum <thorsten.blum@toblux.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240207122127.9182-1-thorsten.blum@toblux.com

show more ...


# a7ddcea5 04-Sep-2018 Henrik Austad <henrik@austad.us>

Drop all 00-INDEX files from Documentation/

This is a respin with a wider audience (all that get_maintainer returned)
and I know this spams a *lot* of people. Not sure what would be the correct
way,

Drop all 00-INDEX files from Documentation/

This is a respin with a wider audience (all that get_maintainer returned)
and I know this spams a *lot* of people. Not sure what would be the correct
way, so my apologies for ruining your inbox.

The 00-INDEX files are supposed to give a summary of all files present
in a directory, but these files are horribly out of date and their
usefulness is brought into question. Often a simple "ls" would reveal
the same information as the filenames are generally quite descriptive as
a short introduction to what the file covers (it should not surprise
anyone what Documentation/sched/sched-design-CFS.txt covers)

A few years back it was mentioned that these files were no longer really
needed, and they have since then grown further out of date, so perhaps
it is time to just throw them out.

A short status yields the following _outdated_ 00-INDEX files, first
counter is files listed in 00-INDEX but missing in the directory, last
is files present but not listed in 00-INDEX.

List of outdated 00-INDEX:
Documentation: (4/10)
Documentation/sysctl: (0/1)
Documentation/timers: (1/0)
Documentation/blockdev: (3/1)
Documentation/w1/slaves: (0/1)
Documentation/locking: (0/1)
Documentation/devicetree: (0/5)
Documentation/power: (1/1)
Documentation/powerpc: (0/5)
Documentation/arm: (1/0)
Documentation/x86: (0/9)
Documentation/x86/x86_64: (1/1)
Documentation/scsi: (4/4)
Documentation/filesystems: (2/9)
Documentation/filesystems/nfs: (0/2)
Documentation/cgroup-v1: (0/2)
Documentation/kbuild: (0/4)
Documentation/spi: (1/0)
Documentation/virtual/kvm: (1/0)
Documentation/scheduler: (0/2)
Documentation/fb: (0/1)
Documentation/block: (0/1)
Documentation/networking: (6/37)
Documentation/vm: (1/3)

Then there are 364 subdirectories in Documentation/ with several files that
are missing 00-INDEX alltogether (and another 120 with a single file and no
00-INDEX).

I don't really have an opinion to whether or not we /should/ have 00-INDEX,
but the above 00-INDEX should either be removed or be kept up to date. If
we should keep the files, I can try to keep them updated, but I rather not
if we just want to delete them anyway.

As a starting point, remove all index-files and references to 00-INDEX and
see where the discussion is going.

Signed-off-by: Henrik Austad <henrik@austad.us>
Acked-by: "Paul E. McKenney" <paulmck@linux.vnet.ibm.com>
Just-do-it-by: Steven Rostedt <rostedt@goodmis.org>
Reviewed-by: Jens Axboe <axboe@kernel.dk>
Acked-by: Paul Moore <paul@paul-moore.com>
Acked-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Acked-by: Mark Brown <broonie@kernel.org>
Acked-by: Mike Rapoport <rppt@linux.vnet.ibm.com>
Cc: [Almost everybody else]
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

show more ...


# 4b290af0 21-Mar-2018 Jonathan Corbet <corbet@lwn.net>

Docs: Added a pointer to the formatted docs to README

Kernel.org nicely maintains an online copy of the formatted documentation;
tell our users that it exists.

Signed-off-by: Jonathan Corbet <corbe

Docs: Added a pointer to the formatted docs to README

Kernel.org nicely maintains an online copy of the formatted documentation;
tell our users that it exists.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>

show more ...


# 9f4a68e4 16-Mar-2018 Martin Kepplinger <martink@posteo.de>

README: Improve documentation descriptions

"This file" indeed was moved once, but at some point "this file", the
top-level README, becomes a file in itself. Now that time has come :)

Let's describe

README: Improve documentation descriptions

"This file" indeed was moved once, but at some point "this file", the
top-level README, becomes a file in itself. Now that time has come :)

Let's describe how things are, and suggest reading "this file" first,
"this file" simply being a the admin-guide README file, not a file that
was once moved.

Signed-off-by: Martin Kepplinger <martink@posteo.de>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

show more ...


# 6bef44b9 18-Oct-2016 Mauro Carvalho Chehab <mchehab@s-opensource.com>

README: add a new README file, pointing to the Documentation/

As we moved the real README file to Documentation/admin-guide/README.rst,
let's add a replacement, pointing to it, and giving the main d

README: add a new README file, pointing to the Documentation/

As we moved the real README file to Documentation/admin-guide/README.rst,
let's add a replacement, pointing to it, and giving the main directions
about documentation.

In the future, perhaps it would be worth to move the contents
of Documentation/00-Index into this README.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

show more ...


# 9d85025b 21-Sep-2016 Mauro Carvalho Chehab <mchehab@s-opensource.com>

docs-rst: create an user's manual book

Place README, REPORTING-BUGS, SecurityBugs and kernel-parameters
on an user's manual book.

As we'll be numbering the user's manual, remove the manual
numberin

docs-rst: create an user's manual book

Place README, REPORTING-BUGS, SecurityBugs and kernel-parameters
on an user's manual book.

As we'll be numbering the user's manual, remove the manual
numbering from SecurityBugs.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

show more ...


# 44b10006 21-Sep-2016 Mauro Carvalho Chehab <mchehab@s-opensource.com>

README: convert it to ReST markup

Adjust the readme file for it to use the ReST markup:

- add chapter/section markups;
- use ``foo`` for commands;
- use :: for verbatim and script blocks;
- replace

README: convert it to ReST markup

Adjust the readme file for it to use the ReST markup:

- add chapter/section markups;
- use ``foo`` for commands;
- use :: for verbatim and script blocks;
- replace unsupported markup _foo_ by **foo**;
- add cross-references to other ReST files;
- use lower case on the section titles, to match other ReST files.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

show more ...


# 35db7e94 26-Jul-2016 Øyvind A. Holm <sunny@sunbase.org>

README: Delete obsolete i386 info + update arch/i386/ paths

Support for i386 was removed in v3.8, delete the paragraph that says
processor types above 386 won't work on that architecture. It's obsol

README: Delete obsolete i386 info + update arch/i386/ paths

Support for i386 was removed in v3.8, delete the paragraph that says
processor types above 386 won't work on that architecture. It's obsolete
information and potentially confusing. Also change a couple of
"arch/i386/" paths to one that exists now, using "arch/x86/" instead.

Signed-off-by: Øyvind A. Holm <sunny@sunbase.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

show more ...


# cfaf790f 03-Apr-2016 Diego Viola <diego.viola@gmail.com>

README: remove trailing whitespace

Signed-off-by: Diego Viola <diego.viola@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>


# 3047bcc5 05-Dec-2015 Diego Viola <diego.viola@gmail.com>

README: cosmetic fixes

Signed-off-by: Diego Viola <diego.viola@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>


# ad29fff8 14-Sep-2015 Vineet Gupta <Vineet.Gupta1@synopsys.com>

README: Add ARC architecture

ARC support was added back in 2013 but I missed updating here

Reported-by: Francois Bedard <fbedard@synopsys.com>
Signed-off-by: Vineet Gupta <vgupta@synopsys.com>
Sign

README: Add ARC architecture

ARC support was added back in 2013 but I missed updating here

Reported-by: Francois Bedard <fbedard@synopsys.com>
Signed-off-by: Vineet Gupta <vgupta@synopsys.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

show more ...


# 6609b638 06-Jul-2015 Diego Viola <diego.viola@gmail.com>

README: GTK+ is a acronym

Signed-off-by: Diego Viola <diego.viola@gmail.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>


# 1913c6f4 03-Mar-2015 Yaowei Bai <bywxiaobai@163.com>

README: Change gzip/bzip2 to xz compression format

Kernel.org is only hosting patches and kernel compressed with xz,
so change the old gzip/bzip2 instances to xz.

Signed-off-by: Yaowei Bai <bywxiao

README: Change gzip/bzip2 to xz compression format

Kernel.org is only hosting patches and kernel compressed with xz,
so change the old gzip/bzip2 instances to xz.

Signed-off-by: Yaowei Bai <bywxiaobai@163.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

show more ...


# 49d86dc9 25-Feb-2015 Jeff Kirsher <jeffrey.t.kirsher@intel.com>

README: Update version number reference

When 4.0 is released, the README should reflect the new numbering.

Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: Jonathan Corbet <

README: Update version number reference

When 4.0 is released, the README should reflect the new numbering.

Signed-off-by: Jeff Kirsher <jeffrey.t.kirsher@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>

show more ...


# 3bd7bf1f 28-Oct-2012 Jiri Kosina <jkosina@suse.cz>

Merge branch 'master' into for-next

Sync up with Linus' tree to be able to apply Cesar's patch
against newer version of the code.

Signed-off-by: Jiri Kosina <jkosina@suse.cz>


# fc0d1b93 24-Oct-2012 Kees Cook <keescook@chromium.org>

README: document "make olddefconfig"

While "olddefconfig" was documented in "make help", it was not mentioned
in the README.

Signed-off-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Jiri Kos

README: document "make olddefconfig"

While "olddefconfig" was documented in "make help", it was not mentioned
in the README.

Signed-off-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

show more ...


# 80b810b2 05-Oct-2012 Steven Rostedt <rostedt@goodmis.org>

localmodconfig: Document localmodconfig in README

Someone (over a year ago :-p) asked me to document localmodconfig in the
README file in the source code. I thought it was a good idea but other
thi

localmodconfig: Document localmodconfig in README

Someone (over a year ago :-p) asked me to document localmodconfig in the
README file in the source code. I thought it was a good idea but other
things were more important and I simply forgot about it. Well, I
stumbled on the email asking me about this and I'm sending it out now.

Signed-off-by: Steven "Mr. Procrastinator" Rostedt <rostedt@goodmis.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

show more ...


# 3773b454 02-Apr-2012 Michael Witten <mfwitten@gmail.com>

README: Remove sporadic tabs

Indentation was already done mainly with spaces, so this commit
removes the tabs and makes some of the whitespace more consistent.

Signed-off-by: Michael Witten <mfwitt

README: Remove sporadic tabs

Indentation was already done mainly with spaces, so this commit
removes the tabs and makes some of the whitespace more consistent.

Signed-off-by: Michael Witten <mfwitten@gmail.com>
Acked-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

show more ...


# 7f65e924 02-Apr-2012 Michael Witten <mfwitten@gmail.com>

README: Consolidate discussions of -stable patches

The nature of the patches for the -stable kernels was discussed
twice; this commit consolidates those discussions into one
paragraph.

Signed-off-b

README: Consolidate discussions of -stable patches

The nature of the patches for the -stable kernels was discussed
twice; this commit consolidates those discussions into one
paragraph.

Signed-off-by: Michael Witten <mfwitten@gmail.com>
Acked-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

show more ...


# c072c3f0 02-Apr-2012 Michael Witten <mfwitten@gmail.com>

README: Capitalize start of sentence

Signed-off-by: Michael Witten <mfwitten@gmail.com>
Acked-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>


# 88f7a642 02-Apr-2012 Michael Witten <mfwitten@gmail.com>

README: More consistent and readable white space

Mainly, this just separates paragraphs, so that the text is easier
on the eyes.

Signed-off-by: Michael Witten <mfwitten@gmail.com>
Acked-by: Randy D

README: More consistent and readable white space

Mainly, this just separates paragraphs, so that the text is easier
on the eyes.

Signed-off-by: Michael Witten <mfwitten@gmail.com>
Acked-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

show more ...


# 6d12760c 02-Apr-2012 Michael Witten <mfwitten@gmail.com>

README: `Alternately' -> `Alternatively'

Also, one `Alternate' was changed to `Alternative' for the
sake of consistency.

Signed-off-by: Michael Witten <mfwitten@gmail.com>
Acked-by: Randy Dunlap <r

README: `Alternately' -> `Alternatively'

Also, one `Alternate' was changed to `Alternative' for the
sake of consistency.

Signed-off-by: Michael Witten <mfwitten@gmail.com>
Acked-by: Randy Dunlap <rdunlap@xenotime.net>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>

show more ...


12