aboutsummaryrefslogtreecommitdiff
AgeCommit message (Collapse)AuthorFilesLines
2018-05-23docs: update kernel versions and dates in tablesTim Bird1-34/+38
Every once in a while, we should update the examples to reflect more recent kernel versions. Update the tables describing kernel releases, the merge window, and current longterm maintained kernel, from 2.6-era kernels to 4.x. Signed-off-by: Tim Bird <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-21docs/vm: transhuge: split userspace bits to admin-guide/mm/transhugeMike Rapoport4-413/+423
Now that the administrative information for transparent huge pages is nicely separated, move it to its own page under the admin guide. Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-21docs/vm: transhuge: minor updatesMike Rapoport1-11/+36
Some formatting changes and addition of a sentence introducing khugepaged Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-21docs/vm: transhuge: change sections orderMike Rapoport1-41/+41
so that userspace interface and implementation description will be grouped together Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-16Documentation: arm: clean up Marvell Berlin family infoThomas Hebb1-8/+7
Remove dead links, make spacing consistent, and note that the family was acquired by Synaptics in 2017. Signed-off-by: Thomas Hebb <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-16Documentation: gpio: driver: Fix a typo and some odd grammarJonathan Neuschäfer1-3/+3
Signed-off-by: Jonathan Neuschäfer <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-10docs: ranoops.rst: fix location of ramoops.txtMauro Carvalho Chehab1-1/+1
The location of the dt bindings file is wrong: it was probably badly renamed by some script. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-10scripts/documentation-file-ref-check: rewrite it in perl with auto-fix modeMauro Carvalho Chehab1-12/+113
The original shell script works, but: 1) it is too slow; 2) it is hard to exclude rejex patterns Convert it to perl. Here, the new version is able to check the entire tree in less than a second (after cached): real 0m0,284s user 0m0,668s sys 0m0,778s The old version takes more than a minute to complete (also after cached): real 1m17,905s user 0m25,583s sys 0m55,334s It also produce less false-positives (if any). The new script also contains an auto-fix mode. Usually, file references get lost when they're moved to some other place and/or renamed to .rst. Add an experimental mode to auto-fix those. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-10docs: uio-howto.rst: use a code block to solve a warningMauro Carvalho Chehab1-1/+2
/devel/v4l/docs/Documentation/driver-api/uio-howto.rst:715: WARNING: Unexpected indentation. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-10mm, THP, doc: Add document for thp_swpout/thp_swpout_fallbackHuang Ying1-0/+9
Add document for newly added thp_swpout, thp_swpout_fallback fields in /proc/vmstat. Signed-off-by: "Huang, Ying" <[email protected]> Cc: "Kirill A. Shutemov" <[email protected]> Cc: Andrea Arcangeli <[email protected]> Cc: Johannes Weiner <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-10w1: w1_io.c: fix a kernel-doc warningMauro Carvalho Chehab1-0/+1
Add a blank line to avoid this Sphinx warning: ./drivers/w1/w1_io.c:197: WARNING: Definition list ends without a blank line; unexpected unindent. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Acked-by: Evgeniy Polyakov <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-10Documentation/process/posting: wrap text at 80 colsJustin Skists1-8/+8
Trivial patch to adjust the text formatting to wrap at 80 columns. No actual content has changed. Signed-off-by: Justin Skists <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-10docs: admin-guide: add cgroup-v2 documentationMauro Carvalho Chehab3-2/+1
The cgroup-v2.txt is already in ReST format. So, move it to the admin-guide, where it belongs. Cc: Li Zefan <[email protected]> Cc: Johannes Weiner <[email protected]> Acked-by: Tejun Heo <[email protected]> Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-10Revert "Documentation/features/vm: Remove arch support status file for ↵Jonathan Corbet1-0/+33
'pte_special'" The removal of this file appears to have been premature; it's not a feature enabled by Kconfig, but it's a arch-level feature regardless. Put it back for now until some happy future time when we decide how we really want to document such features. This reverts commit 2bef69a385b4c1c01d8abae0aa035f0ffa051f07. Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08Documentation: refcount-vs-atomic: Update reference to LKMM doc.Andrea Parri1-1/+1
The LKMM project has moved to 'tools/memory-model/'. Signed-off-by: Andrea Parri <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08docs: driver-api: add clk documentationMauro Carvalho Chehab4-3/+2
The clk.rst is already in ReST format. So, move it to the driver-api guide, where it belongs. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08docs: core-api: add circular-buffers documentationMauro Carvalho Chehab5-4/+3
The circular-buffers.txt is already in ReST format. So, move it to the core-api guide, where it belongs. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08docs: core-api: add cachetlb documentationMauro Carvalho Chehab5-4/+3
The cachetlb.txt is already in ReST format. So, move it to the core-api guide, where it belongs. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08docs: admin-guide: add bcache documentationMauro Carvalho Chehab3-2/+1
The bcache.txt is already in ReST format. So, move it to the admin guide, where it belongs. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08docs: */index.rst: Add newer documents to their respective index.rstMauro Carvalho Chehab4-0/+5
A number of new docs were added, but they're currently not on the index.rst from the session they're supposed to be, causing Sphinx warnings. Add them. Signed-off-by: Mauro Carvalho Chehab <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08docs/vm: move numa_memory_policy.rst to Documentation/admin-guide/mmMike Rapoport8-8/+7
The document describes userspace API and as such it belongs to Documentation/admin-guide/mm Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08docs/vm: numa_memory_policy: s/Linux memory policy/NUMA memory policy/Mike Rapoport1-7/+7
The document describes NUMA memory policy and as it is a part of the Linux documentation it's obvious that this is Linux memory policy. Besides, "Linux memory policy" may refer to other policies, e.g. memory hotplug policy, and using term NUMA makes the documentation less ambiguous. Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08docs/vm: numa_memory_policy: formatting and spelling updatesMike Rapoport1-7/+17
Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08Merge branch 'features' into docs-nextJonathan Corbet44-75/+226
Andrea Parri dice: This series provides the script 'features-refresh.sh', which operates on the arch support status files, and it applies this script to refresh the status files in place; previous discussions about this series are at [1]. [1] http://lkml.kernel.org/r/1523205027-31786-1-git-send-email-andrea.parri@amarulasolutions.com http://lkml.kernel.org/r/1522774551-9503-1-git-send-email-andrea.parri@amarulasolutions.com http://lkml.kernel.org/r/20180328122211.GA25420@andrea
2018-05-08Documentation/features/vm: Remove arch support status file for 'pte_special'Andrea Parri1-33/+0
Suggested-by: Ingo Molnar <[email protected]> Signed-off-by: Andrea Parri <[email protected]> Cc: Ingo Molnar <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: Andrew Morton <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08Documentation/features/lib: Remove arch support status file for 'strncasecmp'Andrea Parri1-33/+0
Suggested-by: Ingo Molnar <[email protected]> Signed-off-by: Andrea Parri <[email protected]> Cc: Ingo Molnar <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: Andrew Morton <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08Documentation/features/locking: Use '!RWSEM_GENERIC_SPINLOCK' as Kconfig for ↵Andrea Parri1-4/+4
'rwsem-optimized' Uses '!RWSEM_GENERIC_SPINLOCK' in place of 'Optimized asm/rwsem.h' as Kconfig for 'rwsem-optimized': the new Kconfig expresses this feature equivalently, while also enabling the script 'features-refresh.sh' to operate on the corresponding arch support status file. Also refreshes the status matrix by using the script 'features-refresh.sh'. Suggested-by: Ingo Molnar <[email protected]> Signed-off-by: Andrea Parri <[email protected]> Cc: Ingo Molnar <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: Andrew Morton <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08Documentation/features/core: Add arch support status files for 'cBPF-JIT' ↵Andrea Parri2-3/+36
and 'eBPF-JIT' Commit 6077776b5908e split 'HAVE_BPF_JIT' into cBPF and eBPF variant. Adds arch support status files for the new variants, and removes the status file corresponding to 'HAVE_BPT_JIT'. The new status matrices were auto-generated using the script 'features-refresh.sh'. Signed-off-by: Andrea Parri <[email protected]> Cc: Ingo Molnar <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: Andrew Morton <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08Documentation/features: Refresh the arch support status files in placeAndrea Parri43-31/+117
Now that the script 'features-refresh.sh' is available, uses this script to refresh all the arch-support.txt files in place. Signed-off-by: Andrea Parri <[email protected]> Cc: Ingo Molnar <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: Andrew Morton <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08Documentation/features: Add script that refreshes the arch support status ↵Andrea Parri1-0/+98
files in place Provides the script: Documentation/features/scripts/features-refresh.sh which operates on the arch-support.txt files and refreshes them in place. This way [1], "[...] we soft- decouple the refreshing of the entries from the introduction of the features, while still making it all easy to keep sync and to extend." [1] http://lkml.kernel.org/r/20180328122211.GA25420@andrea Suggested-by: Ingo Molnar <[email protected]> Signed-off-by: Andrea Parri <[email protected]> Cc: Ingo Molnar <[email protected]> Cc: Jonathan Corbet <[email protected]> Cc: Andrew Morton <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08Documentation: block: cmdline-partition.txt fixes and additionsRandy Dunlap1-7/+14
Make the description of the kernel command line option "blkdevparts" a bit more flowing and readable. Fix a few typos. Add the optional <size> and <offset> suffixes. Note that size can be "-" to indicate all of the remaining space. Signed-off-by: Randy Dunlap <[email protected]> Cc: Cai Zhiyong <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08vfio: fix documentationDong Bo1-3/+2
Update vfio_add_group_dev description to match the current API. Signed-off-by: Dong Bo <[email protected]> Reviewed-by: Cornelia Huck <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-05-08doc: botching-up-ioctls: Make it clearer why structs must be paddedDaniel Vetter1-1/+3
This came up in discussions when reviewing drm patches. Reviewed-by: Eric Anholt <[email protected]> Signed-off-by: Daniel Vetter <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27docs/vm: ksm: split userspace interface to admin-guide/mm/ksm.rstMike Rapoport3-175/+191
Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27docs/vm: ksm: udpate description of stable_node_{dups,chains}Mike Rapoport1-11/+10
Remove implementation details from sysfs parameter descriptions. Also move the paragraph discussing fragmentation issues and their possible solution to the "Design" section. Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27docs/vm: ksm: update stable_node_chains_prune_millisecs descriptionMike Rapoport1-8/+11
Make the description of stable_node_chains_prune_millisecs sysfs parameter less implementation aware and add a few words about this parameter in the "Design" section. Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27docs/vm: ksm: reshuffle text between "sysfs" and "design" sectionsMike Rapoport1-21/+30
The description of "max_page_sharing" sysfs attribute includes lots of implementation details that more naturally belong in the "Design" section. Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27docs/vm: ksm: add "Design" sectionMike Rapoport1-0/+39
Include the KSM description from the source code comment, add a subsection about reverse mapping and include kernel-doc references for KSM data structures. Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27docs/vm: ksm: (mostly) formatting updatesMike Rapoport1-41/+69
Aside from the formatting: * fixed typos * added section and sub-section headers * moved ksmd overview after the description of KSM origins Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27mm/ksm: docs: extend overview comment and make it "DOC:"Mike Rapoport1-1/+18
The existing comment provides a good overview of KSM implementation. Let's update it to reflect recent additions of "chain" and "dup" variants of the stable tree nodes and mark it as "DOC:" for inclusion into the KSM documentation. Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27Documentation: driver-api: fix device_connection.rst kernel-doc errorRandy Dunlap1-1/+1
Using incorrect :functions: syntax (extra space) causes an odd kernel-doc warning, so fix that. Documentation/driver-api/device_connection.rst:42: ERROR: Error in "kernel-doc" directive: Signed-off-by: Randy Dunlap <[email protected]> Reviewed-by: Heikki Krogerus <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27documentation: core-api: rearrange a few kernel-api chapters and sectionsRandy Dunlap1-30/+30
Rearrange some kernel-api chapters and sections to group them together better. - move Bit Operations from Basic C Library Functions to Basic Kernel Library Functions (now adjacent to Bitmap Operations since they are not typical C library functions) - move Sorting from Math Functions to Basic Kernel Library Functions since sort functions are more Basic than Math Functions - move Text Searching from Math Functions to Basic Kernel Library Functions (keep Sorting and Searching close to each other) - combine CRC and Math functions together into the (newly named) CRC and Math Functions chapter Signed-off-by: Randy Dunlap <[email protected]> Acked-by: Matthew Wilcox <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27Merge tag 'v4.17-rc2' into docs-nextJonathan Corbet325-2482/+5654
Merge -rc2 to pick up the changes to Documentation/core-api/kernel-api.rst that hit mainline via the networking tree. In their absence, subsequent patches cannot be applied.
2018-04-27docs/admin-guide/mm: convert plain text cross references to hyperlinksMike Rapoport3-10/+16
Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27docs/admin-guide/mm: start moving here files from Documentation/vmMike Rapoport16-31/+28
Several documents in Documentation/vm fit quite well into the "admin/user guide" category. The documents that don't overload the reader with lots of implementation details and provide coherent description of certain feature can be moved to Documentation/admin-guide/mm. Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27docs/admin-guide: introduce basic index for mm documentationMike Rapoport2-0/+20
Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27docs/vm: pagemap: change document titleMike Rapoport1-3/+3
"pagemap from the Userspace Perspective" is not very descriptive for unaware readers. Since the document describes how to examine a process page tables, let's title it "Examining Process Page Tables" Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27docs/vm: pagemap: formatting and spelling updatesMike Rapoport1-8/+8
Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27docs/vm: hugetlbpage: move section about kernel development to hugetlbfs_reservMike Rapoport2-8/+8
The hugetlbpage describes hugetlbfs from the user perspective and newer hugetlbfs_reserv document targets kernel developers. Hence the section about hugetlbfs kernel development naturally belongs there. Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
2018-04-27docs/vm: hugetlbpage: minor improvementsMike Rapoport1-7/+10
* fixed mistypes * added internal cross-references for sections Signed-off-by: Mike Rapoport <[email protected]> Signed-off-by: Jonathan Corbet <[email protected]>
Powered by cgit, Gruvboxed by Blaster4385.