path: root/README
AgeCommit message (Collapse)Author
2018-09-09Drop all 00-INDEX files from Documentation/Henrik Austad
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 <> Acked-by: "Paul E. McKenney" <> Just-do-it-by: Steven Rostedt <> Reviewed-by: Jens Axboe <> Acked-by: Paul Moore <> Acked-by: Greg Kroah-Hartman <> Acked-by: Mark Brown <> Acked-by: Mike Rapoport <> Cc: [Almost everybody else] Signed-off-by: Jonathan Corbet <>
2018-03-21Docs: Added a pointer to the formatted docs to READMEJonathan Corbet nicely maintains an online copy of the formatted documentation; tell our users that it exists. Signed-off-by: Jonathan Corbet <>
2018-03-21README: Improve documentation descriptionsMartin Kepplinger
"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 <> Signed-off-by: Jonathan Corbet <>
2016-10-24README: add a new README file, pointing to the Documentation/Mauro Carvalho Chehab
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 <>
2016-10-24docs-rst: create an user's manual bookMauro Carvalho Chehab
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 <>
2016-10-24README: convert it to ReST markupMauro Carvalho Chehab
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 <>
2016-08-14README: Delete obsolete i386 info + update arch/i386/ pathsØyvind A. Holm
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 <> Signed-off-by: Jonathan Corbet <>
2016-04-15README: remove trailing whitespaceDiego Viola
Signed-off-by: Diego Viola <> Signed-off-by: Jonathan Corbet <>
2016-01-25README: cosmetic fixesDiego Viola
Signed-off-by: Diego Viola <> Signed-off-by: Jonathan Corbet <>
2015-09-18README: Add ARC architectureVineet Gupta
ARC support was added back in 2013 but I missed updating here Reported-by: Francois Bedard <> Signed-off-by: Vineet Gupta <> Signed-off-by: Jonathan Corbet <>
2015-07-10README: GTK+ is a acronymDiego Viola
Signed-off-by: Diego Viola <> Signed-off-by: Jonathan Corbet <>
2015-03-20README: Change gzip/bzip2 to xz compression formatYaowei Bai is only hosting patches and kernel compressed with xz, so change the old gzip/bzip2 instances to xz. Signed-off-by: Yaowei Bai <> Signed-off-by: Jonathan Corbet <>
2015-03-20README: Update version number referenceJeff Kirsher
When 4.0 is released, the README should reflect the new numbering. Signed-off-by: Jeff Kirsher <> Signed-off-by: Jonathan Corbet <>
2012-10-28Merge branch 'master' into for-nextJiri Kosina
Sync up with Linus' tree to be able to apply Cesar's patch against newer version of the code. Signed-off-by: Jiri Kosina <>
2012-10-25README: document "make olddefconfig"Kees Cook
While "olddefconfig" was documented in "make help", it was not mentioned in the README. Signed-off-by: Kees Cook <> Signed-off-by: Jiri Kosina <>
2012-10-08localmodconfig: Document localmodconfig in READMESteven Rostedt
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 <> Signed-off-by: Linus Torvalds <>
2012-04-17README: Remove sporadic tabsMichael Witten
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 <> Acked-by: Randy Dunlap <> Signed-off-by: Jiri Kosina <>
2012-04-17README: Consolidate discussions of -stable patchesMichael Witten
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 <> Acked-by: Randy Dunlap <> Signed-off-by: Jiri Kosina <>
2012-04-17README: Capitalize start of sentenceMichael Witten
Signed-off-by: Michael Witten <> Acked-by: Randy Dunlap <> Signed-off-by: Jiri Kosina <>
2012-04-17README: More consistent and readable white spaceMichael Witten
Mainly, this just separates paragraphs, so that the text is easier on the eyes. Signed-off-by: Michael Witten <> Acked-by: Randy Dunlap <> Signed-off-by: Jiri Kosina <>
2012-04-17README: `Alternately' -> `Alternatively'Michael Witten
Also, one `Alternate' was changed to `Alternative' for the sake of consistency. Signed-off-by: Michael Witten <> Acked-by: Randy Dunlap <> Signed-off-by: Jiri Kosina <>
2012-04-17README: Better comma usageMichael Witten
For the most part, this commit simply introduces commas to offset modifiers. Signed-off-by: Michael Witten <> Acked-by: Randy Dunlap <> Signed-off-by: Jiri Kosina <>
2012-04-17README: Grammar: `me has' -> `I have'Michael Witten
Signed-off-by: Michael Witten <> Acked-by: Randy Dunlap <> Signed-off-by: Jiri Kosina <>
2012-04-17README: Use `X' and `x' consistentlyMichael Witten
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 <> Acked-by: Randy Dunlap <> Signed-off-by: Jiri Kosina <>
2011-07-01Update version number references in READMEJesper Juhl
When 3.0 is released I believe the README should reflect the new numbering. Signed-off-by: Jesper Juhl <> Signed-off-by: Linus Torvalds <>
2011-02-23Readme: Add architectureTracey Dent
Add Tilera Tile architecture to the list of the architectures that Linux at least runs on. Signed-off-by: Tracey Dent <> Signed-off-by: Chris Metcalf <>
2010-10-13README: cite nconfigAndrea Gelmini
Signed-off-by: Andrea Gelmini <> Signed-off-by: Andrew Morton <> Signed-off-by: Michal Marek <>
2009-06-14README: fix misleading pointer to the defconf directoryPatrick Ringl
Signed-off-by: Patrick Ringl <> Cc: Arnd Bergmann <>
2009-06-09kconfig: add a note about the deps to the 'silentoldconfig' helpMarkus Heidelberg
Signed-off-by: Markus Heidelberg <> Signed-off-by: Sam Ravnborg <>
2009-02-20README: fix a wrong filenameLi Zefan
It should be Documentation/build/kconfig.txt. Introduced by commit 2af238e455ef5fd31c2f7a06c2db3f13d843b9bf ("kbuild: make *config usage docs"). Signed-off-by: Li Zefan <> Cc: Sam Ravnborg <> Signed-off-by: Andrew Morton <> Signed-off-by: Linus Torvalds <>
2009-01-02kbuild: make *config usage docsRandy Dunlap
Create a kconfig user assistance guide, with a few tips and hints about using menuconfig, xconfig, and gconfig. Mostly contains user interface, environment variables, and search topics, along with mini.config/custom.config usage. Signed-off-by: Randy Dunlap <> Signed-off-by: Sam Ravnborg <>
2007-11-17x86: simplify "make ARCH=x86" and fix kconfig all.configSam Ravnborg
Simplify "make ARCH=x86" and fix kconfig so we again can set 64BIT in all.config. For a fix the diffstat is nice: 6 files changed, 3 insertions(+), 36 deletions(-) The patch reverts these commits: - 0f855aa64b3f63d35a891510cf7db932a435c116 ("kconfig: add helper to set config symbol from environment variable") - 2a113281f5cd2febbab21a93c8943f8d3eece4d3 ("kconfig: use $K64BIT to set 64BIT with all*config targets") Roman Zippel pointed out that kconfig supported string compares so the additional complexity introduced by the above two patches were not needed. With this patch we have following behaviour: # make {allno,allyes,allmod,rand}config [ARCH=...] option \ host arch | 32bit | 64bit ===================================================== ./. | 32bit | 64bit ARCH=x86 | 32bit | 32bit ARCH=i386 | 32bit | 32bit ARCH=x86_64 | 64bit | 64bit The general rule are that ARCH= and native architecture takes precedence over the configuration. So make ARCH=i386 [whatever] will always build a 32-bit kernel no matter what the configuration says. The configuration will be updated to 32-bit if it was configured to 64-bit and the other way around. This behaviour is consistent with previous behaviour so no suprises here. make ARCH=x86 will per default result in a 32-bit kernel but as the only ARCH= value x86 allow the user to select between 32-bit and 64-bit using menuconfig. Signed-off-by: Sam Ravnborg <> Cc: Roman Zippel <> Cc: Andreas Herrmann <> Cc: Thomas Gleixner <> Cc: Ingo Molnar <> Cc: "H. Peter Anvin" <> Signed-off-by: Linus Torvalds <>
2007-11-12kconfig: use $K64BIT to set 64BIT with all*config targetsSam Ravnborg
The variable K64BIT can now be used to select the value of CONFIG_64BIT. This is for example useful for powerpc to generate allmodconfig for both bit sizes - like this: make ARCH=powerpc K64BIT=y make ARCH=powerpc K64BIT=n To use this the Kconfig file must use "64BIT" as the config value to select between 32 and 64 bit. Signed-off-by: Sam Ravnborg <> Cc: Roman Zippel <>
2007-02-17Remove duplicate listing of Cris arch from READMEJesper Juhl
Mikael Pettersson pointed out to me that a recent patch of mine (commit 620034c84d1d939717bdfbe02c51a3fee43541c3), that made some corrections to the README file, accidentally listed the Cris architecture twice. Whoops. This patch removes the duplicate. Signed-off-by: Jesper Juhl <> Signed-off-by: Adrian Bunk <>
2007-01-23Change Linus' email address tooLinus Torvalds
This changes a few mentions of my email address to point to the new one, leaving things like old copyright messages alone. Signed-off-by: Linus Torvalds <>
2006-12-06[PATCH] A few small additions and corrections to READMEJesper Juhl
Here's a small patch which - adds a few archs to the current list of supported platforms. - adds a few missing slashes at the end of URLs. - adds a few references to additional documentation. - adds "make config" to the list of possible configuration targets. - makes a few other minor changes. Signed-off-by: Jesper Juhl <> [ Ben Nizette <> points out AVR32 arch too ] Signed-off-by: Linus Torvalds <>
2006-04-19[PATCH] config: update usage/help infoRandy Dunlap
Replace outdated help message with a reference to README. Update README for make *config variants and environment variable info. Signed-off-by: Randy Dunlap <> Acked-by: Sam Ravnborg <> Signed-off-by: Andrew Morton <> Signed-off-by: Linus Torvalds <>
2006-03-20README: bzip2 is not newHkon Lvdal
From: Hkon Lvdal <> Signed-off-by: Hkon Lvdal <> Signed-off-by: Alexey Dobriyan <> Signed-off-by: Adrian Bunk <>
2006-01-16[PATCH] README updatedXose Vazquez Perez
Replace old information with newer from Signed-off-by: Linus Torvalds <>
2006-01-08[PATCH] remove gcc-2 checksAndrew Morton
Remove various things which were checking for gcc-1.x and gcc-2.x compilers. From: Adrian Bunk <> Some documentation updates and removes some code paths for gcc < 3.2. Acked-by: Russell King <> Signed-off-by: Adrian Bunk <> Signed-off-by: Andrew Morton <> Signed-off-by: Linus Torvalds <>
2005-11-13[PATCH] README: add info about -stable to README and point at ↵Jesper Juhl
applying-patches.txt Signed-off-by: Jesper Juhl <> Signed-off-by: Andrew Morton <> Signed-off-by: Linus Torvalds <>
2005-10-30[PATCH] README doesn't mention bzip2 source tarballHorms
Signed-off-by: Andrew Morton <> Signed-off-by: Linus Torvalds <>
2005-09-22[PATCH] corrections to top-level READMERandy Dunlap
Corrections to the recent top-level README changes. Signed-off-by: Randy Dunlap <> Signed-off-by: Andrew Morton <> Signed-off-by: Linus Torvalds <>
2005-09-21[PATCH] README update from the stone agePaolo 'Blaisorblade' Giarrusso
We have no options which the user can set in the Makefile. Only the EXTRAVERSION, which is also useful in place of the "backup modules" suggestion. We don't have configuration options in the top Makefile. Signed-off-by: Paolo 'Blaisorblade' Giarrusso <> Signed-off-by: Andrew Morton <> Signed-off-by: Linus Torvalds <>
2005-07-27[PATCH] Add text for dealing with "dot releases" to READMEKurt Wall
The emergence of so-called "dot releases" that are non-incremental patches against a base kernel requires different handling of patches (revert previous patches before applying the newest one). This patch adds a paragrach to $TOPDIR/README explaining how to do deal with dot release patches. Signed-off-by: Kurt Wall <> Signed-off-by: Andrew Morton <> Signed-off-by: Linus Torvalds <>
2005-04-16Linux-2.6.12-rc2v2.6.12-rc2Linus Torvalds
Initial git repository build. I'm not bothering with the full history, even though we have it. We can create a separate "historical" git archive of that later if we want to, and in the meantime it's about 3.2GB when imported into git - space that would just make the early git days unnecessarily complicated, when we don't have a lot of good infrastructure for it. Let it rip!