aboutsummaryrefslogtreecommitdiff
path: root/README
AgeCommit message (Collapse)AuthorFilesLines
2018-09-09Drop all 00-INDEX files from Documentation/Henrik Austad1-1/+0
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]>
2018-03-21Docs: Added a pointer to the formatted docs to READMEJonathan Corbet1-1/+3
Kernel.org nicely maintains an online copy of the formatted documentation; tell our users that it exists. Signed-off-by: Jonathan Corbet <[email protected]>
2018-03-21README: Improve documentation descriptionsMartin Kepplinger1-4/+3
"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]>
2016-10-24README: add a new README file, pointing to the Documentation/Mauro Carvalho Chehab1-0/+18
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]>
2016-10-24docs-rst: create an user's manual bookMauro Carvalho Chehab1-411/+0
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 <[email protected]>
2016-10-24README: convert it to ReST markupMauro Carvalho Chehab1-47/+58
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]>
2016-08-14README: Delete obsolete i386 info + update arch/i386/ pathsØyvind A. Holm1-6/+2
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]>
2016-04-15README: remove trailing whitespaceDiego Viola1-10/+10
Signed-off-by: Diego Viola <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2016-01-25README: cosmetic fixesDiego Viola1-7/+7
Signed-off-by: Diego Viola <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2015-09-18README: Add ARC architectureVineet Gupta1-1/+1
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]>
2015-07-10README: GTK+ is a acronymDiego Viola1-1/+1
Signed-off-by: Diego Viola <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2015-03-20README: Change gzip/bzip2 to xz compression formatYaowei Bai1-13/+5
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]>
2015-03-20README: Update version number referenceJeff Kirsher1-17/+17
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]>
2012-10-28Merge branch 'master' into for-nextJiri Kosina1-0/+18
Sync up with Linus' tree to be able to apply Cesar's patch against newer version of the code. Signed-off-by: Jiri Kosina <[email protected]>
2012-10-25README: document "make olddefconfig"Kees Cook1-0/+4
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]>
2012-10-08localmodconfig: Document localmodconfig in READMESteven Rostedt1-0/+18
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]>
2012-04-17README: Remove sporadic tabsMichael Witten1-70/+70
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]>
2012-04-17README: Consolidate discussions of -stable patchesMichael Witten1-13/+6
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]>
2012-04-17README: Capitalize start of sentenceMichael Witten1-3/+3
Signed-off-by: Michael Witten <[email protected]> Acked-by: Randy Dunlap <[email protected]> Signed-off-by: Jiri Kosina <[email protected]>
2012-04-17README: More consistent and readable white spaceMichael Witten1-10/+31
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]>
2012-04-17README: `Alternately' -> `Alternatively'Michael Witten1-3/+3
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]>
2012-04-17README: Better comma usageMichael Witten1-8/+8
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]>
2012-04-17README: Grammar: `me has' -> `I have'Michael Witten1-1/+1
Signed-off-by: Michael Witten <[email protected]> Acked-by: Randy Dunlap <[email protected]> Signed-off-by: Jiri Kosina <[email protected]>
2012-04-17README: Use `X' and `x' consistentlyMichael Witten1-9/+9
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]>
2011-07-01Update version number references in READMEJesper Juhl1-21/+21
When 3.0 is released I believe the README should reflect the new numbering. Signed-off-by: Jesper Juhl <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2011-02-23Readme: Add architectureTracey Dent1-1/+1
Add Tilera Tile architecture to the list of the architectures that Linux at least runs on. Signed-off-by: Tracey Dent <[email protected]> Signed-off-by: Chris Metcalf <[email protected]>
2010-10-13README: cite nconfigAndrea Gelmini1-0/+1
Signed-off-by: Andrea Gelmini <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Michal Marek <[email protected]>
2009-06-14README: fix misleading pointer to the defconf directoryPatrick Ringl1-1/+9
Signed-off-by: Patrick Ringl <[email protected]> Cc: Arnd Bergmann <[email protected]>
2009-06-09kconfig: add a note about the deps to the 'silentoldconfig' helpMarkus Heidelberg1-0/+1
Signed-off-by: Markus Heidelberg <[email protected]> Signed-off-by: Sam Ravnborg <[email protected]>
2009-02-20README: fix a wrong filenameLi Zefan1-1/+1
It should be Documentation/build/kconfig.txt. Introduced by commit 2af238e455ef5fd31c2f7a06c2db3f13d843b9bf ("kbuild: make *config usage docs"). Signed-off-by: Li Zefan <[email protected]> Cc: Sam Ravnborg <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2009-01-02kbuild: make *config usage docsRandy Dunlap1-12/+20
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 <[email protected]> Signed-off-by: Sam Ravnborg <[email protected]>
2007-11-17x86: simplify "make ARCH=x86" and fix kconfig all.configSam Ravnborg1-2/+0
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 <[email protected]> Cc: Roman Zippel <[email protected]> Cc: Andreas Herrmann <[email protected]> Cc: Thomas Gleixner <[email protected]> Cc: Ingo Molnar <[email protected]> Cc: "H. Peter Anvin" <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2007-11-12kconfig: use $K64BIT to set 64BIT with all*config targetsSam Ravnborg1-0/+2
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 <[email protected]> Cc: Roman Zippel <[email protected]>
2007-02-17Remove duplicate listing of Cris arch from READMEJesper Juhl1-1/+1
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 <[email protected]> Signed-off-by: Adrian Bunk <[email protected]>
2007-01-23Change Linus' email address tooLinus Torvalds1-2/+2
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 <[email protected]>
2006-12-06[PATCH] A few small additions and corrections to READMEJesper Juhl1-6/+11
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 <[email protected]> [ Ben Nizette <[email protected]> points out AVR32 arch too ] Signed-off-by: Linus Torvalds <[email protected]>
2006-04-19[PATCH] config: update usage/help infoRandy Dunlap1-1/+22
Replace outdated help message with a reference to README. Update README for make *config variants and environment variable info. Signed-off-by: Randy Dunlap <[email protected]> Acked-by: Sam Ravnborg <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2006-03-20README: bzip2 is not newH�kon L�vdal1-1/+1
From: H�kon L�vdal <[email protected]> Signed-off-by: H�kon L�vdal <[email protected]> Signed-off-by: Alexey Dobriyan <[email protected]> Signed-off-by: Adrian Bunk <[email protected]>
2006-01-16[PATCH] README updatedXose Vazquez Perez1-11/+19
Replace old information with newer from kernel.org Signed-off-by: Linus Torvalds <[email protected]>
2006-01-08[PATCH] remove gcc-2 checksAndrew Morton1-5/+2
Remove various things which were checking for gcc-1.x and gcc-2.x compilers. From: Adrian Bunk <[email protected]> Some documentation updates and removes some code paths for gcc < 3.2. Acked-by: Russell King <[email protected]> Signed-off-by: Adrian Bunk <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2005-11-13[PATCH] README: add info about -stable to README and point at ↵Jesper Juhl1-0/+5
applying-patches.txt Signed-off-by: Jesper Juhl <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2005-10-30[PATCH] README doesn't mention bzip2 source tarballHorms1-0/+4
Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2005-09-22[PATCH] corrections to top-level READMERandy Dunlap1-4/+4
Corrections to the recent top-level README changes. Signed-off-by: Randy Dunlap <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2005-09-21[PATCH] README update from the stone agePaolo 'Blaisorblade' Giarrusso1-3/+6
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 <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2005-07-27[PATCH] Add text for dealing with "dot releases" to READMEKurt Wall1-0/+10
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 <[email protected]> Signed-off-by: Andrew Morton <[email protected]> Signed-off-by: Linus Torvalds <[email protected]>
2005-04-16Linux-2.6.12-rc2Linus Torvalds1-0/+305
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!
Powered by cgit, Gruvboxed by Blaster4385.