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 <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
Message-ID: <[email protected]>

show more ...

README: Fix spelling/capitalization

- Fix spelling/capitalization s/Restructured/ReStructured/

Signed-off-by: Thorsten Blum <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]

README: Fix spelling/capitalization

- Fix spelling/capitalization s/Restructured/ReStructured/

Signed-off-by: Thorsten Blum <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>
Link: https://lore.kernel.org/r/[email protected]

show more ...

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 <[email protected]>
Acked-by: "Paul E. McKenney" <[email protected]>
Just-do-it-by: Steven Rostedt <[email protected]>
Reviewed-by: Jens Axboe <[email protected]>
Acked-by: Paul Moore <[email protected]>
Acked-by: Greg Kroah-Hartman <[email protected]>
Acked-by: Mark Brown <[email protected]>
Acked-by: Mike Rapoport <[email protected]>
Cc: [Almost everybody else]
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

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 <[email protected]>

show more ...

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 <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

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 <[email protected]>

show more ...

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 <[email protected]>

show more ...

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 <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

README: remove trailing whitespace

Signed-off-by: Diego Viola <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

README: cosmetic fixes

Signed-off-by: Diego Viola <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

README: Add ARC architecture

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

Reported-by: Francois Bedard <[email protected]>
Signed-off-by: Vineet Gupta <[email protected]>
Sign

README: Add ARC architecture

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

Reported-by: Francois Bedard <[email protected]>
Signed-off-by: Vineet Gupta <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

README: GTK+ is a acronym

Signed-off-by: Diego Viola <[email protected]>
Signed-off-by: Jiri Kosina <[email protected]>

README: GTK+ is a acronym

Signed-off-by: Diego Viola <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

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 <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

README: Update version number reference

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

Signed-off-by: Jeff Kirsher <[email protected]>
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 <[email protected]>
Signed-off-by: Jonathan Corbet <[email protected]>

show more ...

README: document "make olddefconfig"

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

Signed-off-by: Kees Cook <[email protected]>
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 <[email protected]>
Signed-off-by: Jiri Kosina <[email protected]>

show more ...

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 <[email protected]>
Signed-off-by: Linus Torvalds <[email protected]>

show more ...

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 <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Signed-off-by: Jiri Kosina <[email protected]>

show more ...

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 <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Signed-off-by: Jiri Kosina <[email protected]>

show more ...

README: Capitalize start of sentence

Signed-off-by: Michael Witten <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Signed-off-by: Jiri Kosina <[email protected]>

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 <[email protected]>
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 <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Signed-off-by: Jiri Kosina <[email protected]>

show more ...

README: `Alternately' -> `Alternatively'

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

Signed-off-by: Michael Witten <[email protected]>
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 <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Signed-off-by: Jiri Kosina <[email protected]>

show more ...

README: Better comma usage

For the most part, this commit simply introduces commas to
offset modifiers.

Signed-off-by: Michael Witten <[email protected]>
Acked-by: Randy Dunlap <[email protected]

README: Better comma usage

For the most part, this commit simply introduces commas to
offset modifiers.

Signed-off-by: Michael Witten <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Signed-off-by: Jiri Kosina <[email protected]>

show more ...

README: Grammar: `me has' -> `I have'

Signed-off-by: Michael Witten <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Signed-off-by: Jiri Kosina <[email protected]>

README: Use `X' and `x' consistently

The text referred to `XX', when only a single `X' actually
existed, so this commit changes it to just `X'; a similar
change has been made for `xx'.

Also, `N' wa

README: Use `X' and `x' consistently

The text referred to `XX', when only a single `X' actually
existed, so this commit changes it to just `X'; a similar
change has been made for `xx'.

Also, `N' was used when it would have been more consistent
to use `X' again, so this commit replaces `N' with `X'.

This commit also chooses to leave `X' as the placeholder
for the current version of the source, and then makes `x'
the placeholder for any version number; fortunately nothing
really depends on this subtlety being understood.

Because `x' is already being used when discussing version
numbers, this commit changes such filename references as
`xxx.rej' to `some-file-name.rej'.

Signed-off-by: Michael Witten <[email protected]>
Acked-by: Randy Dunlap <[email protected]>
Signed-off-by: Jiri Kosina <[email protected]>

show more ...