summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* documentation: fb: update list of available compiled-in fontsRandy Dunlap2017-11-081-2/+2
| | | | | | | | | | | Update list of available compiled-in fonts in lib/fonts/: add 6x10 and drop RomanLarge (which was reverted 12 years ago). Also sort the list alphabetically. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Acked-by: Geert Uytterhoeven <geert@linux-m68k.org> # v1 Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* MAINTAINERS: update DMAengine documentation locationVinod Koul2017-11-051-1/+1
| | | | | | | | WIth ReST style documentation, we moved it to driver-api/dmaengine so update this in MAINTAINERS entry Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: doc: ReSTize pxa_dma docVinod Koul2017-11-053-153/+200
| | | | | | | | This converts and moves pxa_dma file with some format changes for RST style Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: doc: ReSTize dmatest docVinod Koul2017-11-052-39/+67
| | | | | | | | This converts and moves dmatest file with some format changes for RST style Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: doc: ReSTize client API docVinod Koul2017-11-053-222/+286
| | | | | | | | This converts and moves client API file with some format changes for RST style Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: doc: ReSTize provider docVinod Koul2017-11-053-424/+519
| | | | | | | | This moves and converts provider file with some format changes for RST style Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dmaengine: doc: Add ReST style dmaengine documentVinod Koul2017-11-053-8/+14
| | | | | | | | | This removes the index file and adds the index.rst as placeholder and update driver-api index to add dmaengine. As a consequence dmaengine documentation will be in driver-api/ Signed-off-by: Vinod Koul <vinod.koul@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* ftrace/docs: Add documentation on how to use ftrace from within the kernelSteven Rostedt2017-11-051-0/+293
| | | | | | | | | | | | | | With the coming removal of jprobes, using ftrace callbacks is one of the utilities that replace the jprobes functionality. Having a document that explains how to use ftrace as such will help in the transition from jprobes to ftrace. This document is for kernel developers that require attaching a callback to a function within the kernel. Link: http://lkml.kernel.org/r/150724519527.5014.10207042218696587159.stgit@devbox Signed-off-by: Steven Rostedt (VMware) <rostedt@goodmis.org> [jc: fixed one formatting issue that broke the docs build] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* bug-hunting.rst: Fix an example and a typo in a Sphinx tagChristophe JAILLET2017-10-311-4/+4
| | | | | | | | | | - Use the same file name in the explanation and in the example (conex.c vs sonixj.c) - Add a missing ':' in a :ref: tag which leads to incorrect Shpinx output - Add some missing ',' and ';' Signed-off-by: Christophe JAILLET <christophe.jaillet@wanadoo.fr> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* scripts: Add a script to find unused documentationsayli karnik2017-10-231-0/+62
| | | | | | | | Add a script that finds files with kernel-doc comments for imported functions that are not included anywhere in documentation. Signed-off-by: sayli karnik <karniksayli1995@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* samples: Convert timers to use timer_setup()Kees Cook2017-10-191-3/+3
| | | | | | | | | In preparation for unconditionally passing the struct timer_list pointer to all timer callbacks, switch to using the new timer_setup() and from_timer() to pass the timer pointer explicitly. Signed-off-by: Kees Cook <keescook@chromium.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* documentation: kernel-api: add more info on bitmap functionsRandy Dunlap2017-10-193-49/+72
| | | | | | | | | | | | | There are some good comments about bitmap operations in lib/bitmap.c and include/linux/bitmap.h, so format them for document generation and pull them into core-api/kernel-api.rst. I converted the "tables" of functions from using tabs to using spaces so that they are more readable in the source file and in the generated output. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: fix selftests related file refsTom Saeger2017-10-193-3/+3
| | | | | | | | | Make refs to selftests files valid including: - watchdog-test.c - dnotify_test.c Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: fix ref to power basic-pm-debuggingTom Saeger2017-10-191-1/+1
| | | | | | Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: fix ref to trace stm contentTom Saeger2017-10-191-1/+1
| | | | | Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: fix ref to coccinelle contentTom Saeger2017-10-191-1/+1
| | | | | Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: fix ref to workqueue contentTom Saeger2017-10-191-1/+1
| | | | | Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: fix ref to sphinx/kerneldoc.pyTom Saeger2017-10-191-1/+1
| | | | | Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: fix locking rt-mutex doc refsTom Saeger2017-10-192-2/+2
| | | | | Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: dev-tools: correct Coccinelle version numberJulia Lawall2017-10-191-1/+1
| | | | | | | There is no Coccinelle version 1.2. 1.0.2 must be what was intended. Signed-off-by: Julia Lawall <Julia.Lawall@lip6.fr> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* documentation: Update ide-cd documentation to reflect CONFIG_BLK_DEV_HD_IDE ↵Finn Thain2017-10-121-5/+1
| | | | | | | | | | | | removal CONFIG_BLK_DEV_HD_IDE was removed in commit 80aa31cb460d ("ide: remove CONFIG_BLK_DEV_HD_IDE config option (take 2)") but the ide-cd documentation was not updated and still asks users to disable it, which is misleading and involves a fruitless search. Signed-off-by: Finn Thain <fthain@telegraphics.com.au> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'refs' into docs-nextJonathan Corbet2017-10-1231-54/+58
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Tom Saeger says: Recently, while reading up on binfmt I attempted to open a document ref only to find it was invalid. I did a quick grep, found all the binfmt_misc related broken refs and sent a patch. Fine. Easy. Then I wondered, "how many broken doc refs are there?". Turns out with all the recent doc moves, quite a few. I went about fixing just those found in Documentation/, except those in Documentation/translations/ and Documentation/devicetree/ for now. Most of these changes were s/txt/rst/ or fixing up a path to an obvious new location. Some required going back to v4.10 v4.4 or some other version to sleuth-out what content was actually being referenced and then fixing the reference to point to the new file with that content.
| * Documentation: fix networking related doc refs.Tom Saeger2017-10-122-2/+2
| | | | | | | | | | Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: fix usb related doc refsTom Saeger2017-10-123-6/+4
| | | | | | | | | | | | | | Update ref to usb proc_usb_info.txt. Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: fix sound related doc refsTom Saeger2017-10-122-2/+2
| | | | | | | | | | | | | | | | Make sound doc refs valid. Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Reviewed-by: Takashi Iwai <tiwai@suse.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: fix media related doc refsTom Saeger2017-10-126-10/+10
| | | | | | | | | | | | | | Make media doc refs valid. Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: fix security related doc refsTom Saeger2017-10-124-5/+5
| | | | | | | | | | | | | | Make security document refs valid. Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: fix input related doc refsTom Saeger2017-10-124-8/+9
| | | | | | | | | | | | | | | | | | | | Make `input` document refs valid including: - joystick - joystick-parport Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Reviewed-by: Takashi Iwai <tiwai@suse.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: fix admin-guide doc refsTom Saeger2017-10-129-14/+19
| | | | | | | | | | | | | | | | Make admin-guide document refs valid. Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * Documentation: fix driver-api doc refsTom Saeger2017-10-123-7/+7
|/ | | | | | | | Make driver-api document refs valid. Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Acked-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: add script and build target to check for broken file referencesJani Nikula2017-10-123-1/+21
| | | | | | | | | | | | | Add a simple script and build target to do a treewide grep for references to files under Documentation, and report the non-existing file in stderr. It tries to take into account punctuation not part of the filename, and wildcards, but there are bound to be false positives too. Mostly seems accurate though. We've moved files around enough to make having this worthwhile. Signed-off-by: Jani Nikula <jani.nikula@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Makefile: enable dochelp run from main make levelShuah Khan2017-10-121-1/+1
| | | | | | | | Change to enable dochelp run from main make level to make it easier to use it. Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* doc: enhance dochelp include default output location for doc buildShuah Khan2017-10-121-0/+2
| | | | | | | | Enhance documentation help message to specify the default location for the generated documents. Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* doc: dev-tools: kselftest.rst: update to include make O=dir supportShuah Khan2017-10-121-2/+32
| | | | | | | | | Update to include details on make O=dir support and other changes improve test results output. Signed-off-by: Shuah Khan <shuahkh@osg.samsung.com> [jc: Tweaked RST formatting slightly ] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* PM: docs: Fix stale reference in kernel-parameters.txtRafael J. Wysocki2017-10-071-1/+1
| | | | | | | | | | | Commit 7aa7a0360a66 (PM: docs: Delete the obsolete states.txt document) forgot to update kernel-parameters.txt with a reference to the new sleep-states.rst document and it still points to states.txt that was dropped, so fix it now. Fixes: 7aa7a0360a66 (PM: docs: Delete the obsolete states.txt document) Signed-off-by: Rafael J. Wysocki <rafael.j.wysocki@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: add kernel-api section on Math functionsRandy Dunlap2017-10-071-0/+24
| | | | | | | Add a kernel-api section on Math Functions. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* lib/gcd: add kernel-doc notationRandy Dunlap2017-10-071-0/+6
| | | | | | | | Add kernel-doc notation for the gcd() function (so that it can be added to the kernel-api documentation). Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* math64: add missing kernel-doc notationRandy Dunlap2017-10-071-0/+27
| | | | | | | | Add missing kernel-doc notation (function parameters) for several div() functions. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* div64: add missing kernel-docRandy Dunlap2017-10-072-0/+20
| | | | | | | Add missing kernel-doc notation for 2 div() functions. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* linux/log2.h: fix kernel-doc notationRandy Dunlap2017-10-071-19/+23
| | | | | | | | | Fix <linux/log2.h> kernel-doc: - Add kernel-doc notation to some functions. - Fix kernel-doc notation in function parameters. Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: add Kernel Driver Statement to the kernelGreg Kroah-Hartman2017-10-072-0/+200
| | | | | | | | | | | | | | | | | Way back in 2008 we didn't have "robust" in-kernel documentation system, so the idea of putting something like the kernel driver statement in the kernel tree wasn't even imagined. But now that has changed, so add the old document to the kernel source itself to allow for us to properly reference it in one canonical place (as the LF wiki keeps moving things around.) This also will allow people to add their names to it, as I seem to have lost the ability to do that by not knowing how to edit things on the original document. Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org> Acked-by: Mauro Carvalho Chehab <mchehab@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Update binfmt_misc linksTom Saeger2017-10-032-2/+2
| | | | | | | | Documentation/binfmt_misc.txt moved to Documentation/admin-guide/binfmt-misc.rst Signed-off-by: Tom Saeger <tom.saeger@oracle.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: Improve softlockup_panic= description textBorislav Petkov2017-10-031-0/+6
| | | | | | | | | It should say what that <integer> range is and what that integer value means. I had to look at the code... Signed-off-by: Borislav Petkov <bp@suse.de> [jc: changed non-null to nonzero] Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/features/KASAN: mark KASAN as supported only on 64-bit on x86Adam Borowski2017-10-031-1/+1
| | | | | | | | Relevant part is: arch/x86/Kconfig: select HAVE_ARCH_KASAN if X86_64 && SPARSEMEM_VMEMMAP Signed-off-by: Adam Borowski <kilobyte@angband.pl> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* scripts/kernel-doc: warn on excess enum value descriptionsJohannes Berg2017-09-261-4/+13
| | | | | | | | | | | | | | | | | | The existing message "Excess struct/union/enum/typedef member [...]" made it sound like this would already be done, but the code is never invoked for enums or typedefs (and really can't be). Add some code to the enum dumper to handle this there instead. While at it, also make the above message more accurate by simply dumping the type that was passed in, and pass the struct/union differentiation in. Signed-off-by: Johannes Berg <johannes.berg@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: clean up and add rest of CRC functions to kernel-api.rstRandy Dunlap2017-09-264-15/+21
| | | | | | | | | | | | Add the rest of the CRC library functions to kernel-api. - try to clarify crc32() by adding '@' to a function parameter - reorder kernel-api CRC functions to be less random - add more CRC functions to kernel-api - correct the function parameter names in several places Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: highres: fix broken urlsstephen lu2017-09-261-2/+2
| | | | | | | Some urls is invalid. I find alternative urls. Signed-off-by: stephen lu <lumotuwe@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/process: phrasofixJunio C Hamano2017-09-261-1/+1
| | | | | | | | | | | | Devils in the details are found only when the high level design is refined and gets more detailed, and the appropriate phrase to use to describe this is "problems are revealed", not "problems are reviewed". Reviews may reveal these problems, though ;-) Signed-off-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation/process: fix the canonical patch format descriptionJunio C Hamano2017-09-261-4/+4
| | | | | | | | | There shouldn't be a blank line at the beginning, if there is no optional in-body "From" line. There must be a blank line between the body of the explanation and the beginning of the S-o-b lines. Signed-off-by: Junio C Hamano <gitster@pobox.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* console: Update to reflect new default valueDaniel Xu2017-09-261-2/+2
| | | | | | | | The default value was changed from 10 minutes to disabled in commit a4199f5eb8096d6. Signed-off-by: Daniel Xu <dxu@dxuuu.xyz> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-24 08:11:47 +0000