summaryrefslogtreecommitdiffstats
Commit message (Collapse)AuthorAgeFilesLines
* Documentation/scheduler: fix links in sched-statsAndre Azevedo2019-10-291-2/+2
| | | | | | | | | | The rain.com domain recently moved to pdxhosts.com, making the scheduler documentation point to broken links. Fix the links in the scheduler documentation. CC: Rick Lindsley <ricklind@linux.vnet.ibm.com> Signed-off-by: Andre Azevedo <andre.azevedo@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: ioctl: fix typoChris Packham2019-10-241-1/+1
| | | | | | | "pointres" should be "pointers". Signed-off-by: Chris Packham <chris.packham@alliedtelesis.co.nz> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: debugfs: Document debugfs helper for unsigned long valuesGeert Uytterhoeven2019-10-241-2/+8
| | | | | | | | | When debugfs_create_ulong() was added, it was not documented. Fixes: c23fe83138ed7b11 ("debugfs: Add debugfs_create_ulong()") Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be> Acked-by: Viresh Kumar <viresh.kumar@linaro.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: driver-api: Remove reference to sgi-ioc4Harald Seiler2019-10-241-1/+0
| | | | | | | | | | | | | | Commit f7bc6e42bf12 ("drivers: remove the SGI SN2 IOC4 base support") removed support for SGI SN2 IOC4 and the relevant documentation files. Remove a leftover reference in the toctree of the driver-api documentation to fix this sphinx error: Documentation/driver-api/index.rst:14: WARNING: toctree contains reference to nonexisting document 'driver-api/sgi-ioc4' Fixes: f7bc6e42bf12 ("drivers: remove the SGI SN2 IOC4 base support") Signed-off-by: Harald Seiler <hws@denx.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: remove :c:func: from genericirq.rstJonathan Corbet2019-10-181-25/+25
| | | | | | | | As of 5.3, the automarkup extension will do the right thing with function() notation, so we don't need to clutter the text with :c:func: invocations. So remove them. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Updated iostats docsAlbert Vaca Cintora2019-10-181-23/+24
| | | | | | | | Previous docs mentioned 11 unsigned long fields, when the reality is that we have 15 fields with a mix of unsigned long and unsigned int. Signed-off-by: Albert Vaca Cintora <albertvaka@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: w1: Fix SPDX-License-Identifier syntaxJonathan Neuschäfer2019-10-181-1/+1
| | | | | | | ReST directives are introduced with two dots. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: i2c: Fix SPDX-License-Identifier syntaxJonathan Neuschäfer2019-10-182-2/+2
| | | | | | | ReST directives are introduced with two dots. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: driver-api: pti_intel_mid: Enable syntax highlighting for C code blockJonathan Neuschäfer2019-10-181-1/+3
| | | | | | | This makes the code snippet more readable. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: admin-guide: dell_rbu: Improve formatting and spellingJonathan Neuschäfer2019-10-151-4/+4
| | | | | | | This improves readability a bit. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: admin-guide: dell_rbu: Rework the titleJonathan Neuschäfer2019-10-151-3/+3
| | | | | | | | - Mention the driver name, which is also used in sysfs (dell_rbu) - Rewrite the title to be more concise Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: admin-guide: Move Dell RBU document from driver-apiJonathan Neuschäfer2019-10-155-3/+3
| | | | | | | | | This document describes how an admin can use the dell_rbu driver, rather than any in-kernel API details. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Acked-by: Andy Shevchenko <andy.shevchenko@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: admin-guide: Sort the "unordered guides" to avoid merge conflictsJonathan Neuschäfer2019-10-151-32/+32
| | | | | | | | | | Since the "unordered guides" linked in admin-guide/index.rst are not supposed to be in any particular order, let's sort them alphabetically to avoid the risk of merge conflicts by spreading newly added lines more evenly. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: misc: xilinx_sdfec: Actually add documentationDerek Kiernan2019-10-111-0/+291
| | | | | | | | | | | Add SD-FEC driver documentation. Signed-off-by: Derek Kiernan <derek.kiernan@xilinx.com> Signed-off-by: Dragan Cvetic <dragan.cvetic@xilinx.com> Link: https://lore.kernel.org/r/1560274185-264438-11-git-send-email-dragan.cvetic@xilinx.com [kees: extracted from v7 as it was missing in the commit for v8] Signed-off-by: Kees Cook <keescook@chromium.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: SafeSetID.rst: Remove spurious '???' charactersChristian Kujau2019-10-111-2/+2
| | | | | | | | It appears that some smart quotes were changed to "???" by even smarter software; change them to the dumb but legible variety. Signed-off-by: Christian Kujau <lists@nerdbynature.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* dm dust: convert documentation to ReSTBryan Gurney2019-10-102-114/+130
| | | | | | | | | | | | | | | | Convert the dm-dust documentation to ReST formatting, using literal blocks for all of the shell command, shell output, and log output examples. Add dm-dust to index.rst. Additionally, fix an annotation in the "querying for specific bad blocks" section, on the "queryblock ... not found in badblocklist" example, to properly state that the message appears when a given block is not found. Signed-off-by: Bryan Gurney <bgurney@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: admin-guide: fix printk_ratelimit explanationOleksandr Natalenko2019-10-101-2/+4
| | | | | | | | | | | | | | | The printk_ratelimit value accepts seconds, not jiffies (though it is converted into jiffies internally). Update documentation to reflect this. Also, remove the statement about allowing 1 message in 5 seconds since bursts up to 10 messages are allowed by default. Finally, while we are here, mention default value for printk_ratelimit_burst too. Signed-off-by: Oleksandr Natalenko <oleksandr@redhat.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: networking: phy: Improve phrasingJonathan Neuschäfer2019-10-101-1/+1
| | | | | | | | | It's not about times (multiple occurences of an event) but about the duration of a time interval. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Acked-by: David S. Miller <davem@davemloft.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: networking: devlink-trap: Fix reference to other documentJonathan Neuschäfer2019-10-101-1/+1
| | | | | | | | | | | This fixes the following Sphinx warning: Documentation/networking/devlink-trap.rst:175: WARNING: unknown document: /devlink-trap-netdevsim Fixes: 9e0874570488 ("Documentation: Add description of netdevsim traps") Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Acked-by: David S. Miller <davem@davemloft.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* bindings: MAINTAINERS: fix references to Allwinner LRADCMauro Carvalho Chehab2019-10-101-1/+1
| | | | | | | | | The file got converted to yaml, but the reference at MAINTAINERS was not updated. Fixes: 5bf2845ece35 ("dt-bindings: input: Convert Allwinner LRADC to a schema") Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* bindings: rename links to mason USB2/USB3 DT filesMauro Carvalho Chehab2019-10-101-2/+2
| | | | | | | | | | | Those files got renamed, but another DT file still points to the older places. Fixes: 87a55485f2fc ("dt-bindings: phy: meson-g12a-usb3-pcie-phy: convert to yaml") Fixes: da86d286cce8 ("dt-bindings: phy: meson-g12a-usb2-phy: convert to yaml") Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Rob Herring <robh@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: fix some broken referencesMauro Carvalho Chehab2019-10-1010-11/+11
| | | | | | | | | | | | | There are a number of documentation files that got moved or renamed. update their references. Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Acked-by: Shannon Nelson <snelson@pensando.io> Acked-by: Guenter Roeck <linux@roeck-us.net> Acked-by: Rob Herring <robh@kernel.org> Acked-by: Paul Walmsley <paul.walmsley@sifive.com> # RISC-V Acked-by: Bartosz Golaszewski <bgolaszewski@baylibre.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: admin-guide: add earlycon documentation for RISC-VPaul Walmsley2019-10-101-0/+4
| | | | | | | | | | | | | | Kernels booting on RISC-V can specify "earlycon" with no options on the Linux command line, and the generic DT earlycon support will query the "chosen/stdout-path" property (if present) to determine which early console device to use. Document this appropriately in the admin-guide. Signed-off-by: Paul Walmsley <paul.walmsley@sifive.com> Reviewed-by: Geert Uytterhoeven <geert+renesas@glider.be> Cc: Christoph Hellwig <hch@lst.de> Cc: Andreas Schwab <schwab@suse.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: remove :c:func: from genalloc.rstJonathan Corbet2019-10-101-9/+9
| | | | | | | | As of 5.3, the automarkup extension will do the right thing with function() notation, so we don't need to clutter the text with :c:func: invocations. So remove them. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Move the user-space ioctl() docs to userspace-apiJonathan Corbet2019-10-107-1/+1
| | | | | | | This is strictly user-space material at this point, so put it with the other user-space API documentation. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: move botching-up-ioctls.rst to the process guideJonathan Corbet2019-10-103-1/+1
| | | | | | | | This is overall information for kernel developers, and not part of the user-space API. Cc: Daniel Vetter <daniel@ffwll.ch> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Fix "make help" suggestion for SPHINXDIRJonathan Corbet2019-10-101-1/+1
| | | | | | | | | | | Commit 9fc3a18a942f ("docs: remove extra conf.py files") broke the setting of _SPHINXDIRS in Documentation/Makefile. Let's just have it look for an index.rst file instead. Fixes: 9fc3a18a942f ("docs: remove extra conf.py files") Reported-by: Randy Dunlap <rdunlap@infradead.org> Tested-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs/driver-api: Catch up with dma_buf file-name changesJonathan Corbet2019-10-071-3/+3
| | | | | | | | | | | | | | | | | drivers/dma_buf/reservation.c was renamed to dma-resv.c (and include/linux/reservation.h to dma-resv.h), but the documentation was not updated to match, leading to these build errors: Error: Cannot open file ./drivers/dma-buf/reservation.c Error: Cannot open file ./drivers/dma-buf/reservation.c Error: Cannot open file ./drivers/dma-buf/reservation.c Error: Cannot open file ./include/linux/reservation.h Error: Cannot open file ./include/linux/reservation.h Update the documentation and make the world happy again. Fixes: 52791eeec1d9 ("dma-buf: rename reservation_object to dma_resv') Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* genalloc: Fix a set of docs build warningsJonathan Corbet2019-10-072-5/+5
| | | | | | | | | | | | | | | | | | Commit 795ee30648c7 ("lib/genalloc: introduce chunk owners") made a number of changes to the genalloc API and implementation but did not update the documentation to match, leading to these docs build warnings: ./lib/genalloc.c:1: warning: 'gen_pool_add_virt' not found ./lib/genalloc.c:1: warning: 'gen_pool_alloc' not found ./lib/genalloc.c:1: warning: 'gen_pool_free' not found ./lib/genalloc.c:1: warning: 'gen_pool_alloc_algo' not found Fix these by updating the docs to match new function locations and names, and by completing the update of one kerneldoc comment. Fixes: 795ee30648c7 ("lib/genalloc: introduce chunk owners") Acked-by: Dan Williams <dan.j.williams@intel.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: Catch up with the new location of get_user_pages_fast()Jonathan Corbet2019-10-071-1/+1
| | | | | | | | | | | | | | Commit 050a9adc6438 ("mm: consolidate the get_user_pages* implementations") moved get_user_pages_fast() from mm/util.c to mm/gup.c, but didn't update the documentation, leading to this build warning: ./mm/util.c:1: warning: 'get_user_pages_fast' not found Update the docs to match the new reality. Fixes: 050a9adc6438 ("mm: consolidate the get_user_pages* implementations") Reviewed-by: Christoph Hellwig <hch@lst.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: remove :c:func: from refcount-vs-atomic.rstJonathan Corbet2019-10-071-18/+18
| | | | | | | | | | | | As of 5.3, the automarkup extension will do the right thing with function() notation, so we don't need to clutter the text with :c:func: invocations. So remove them. Looking at the generated output reveals that we lack kerneldoc coverage for much of this API, but that's a separate problem. Acked-by: Paul E. McKenney <paulmck@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* riscv-docs: correct the sequence of the magic number 2 since it's little endianChester Lin2019-10-031-1/+1
| | | | | | | | Correct the sequence of the magic number 2 since it's little endian. Signed-off-by: Chester Lin <clin@suse.com> Reviewed-by: Paul Walmsley <paul.walmsley@sifive.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* scripts/sphinx-pre-install: Add a new path for the debian package ↵Jeremy MAURO2019-10-031-1/+2
| | | | | | | | | | | | "fonts-noto-cjk" The latest debian version "bullseye/sid" has changed the path of the file "notoserifcjk-regular.ttc", with the previous change and this change we keep the backward compatibility and add the latest debian version Signed-off-by: Jeremy MAURO <j.mauro@criteo.com> Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* scripts/sphinx-pre-install: allow checking for multiple missing filesJeremy MAURO2019-10-031-9/+11
| | | | | | | | | | | The current implementation take a simple file as first argument, this change allows to take a list as a first argument. Some file could have a different path according distribution version Signed-off-by: Jeremy MAURO <j.mauro@criteo.com> Reviewed-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: networking: device drivers: Remove stray asterisksJonathan Neuschäfer2019-10-0312-56/+56
| | | | | | | | | | | | | | | These asterisks were once references to a line that said: "* Other names and brands may be claimed as the property of others." But now, they serve no purpose; they can only irritate the reader. Fixes: f12a84a9f650 ("Documentation: fm10k: Add kernel documentation") Fixes: 1e06edcc2f22 ("Documentation: i40e: Prepare documentation for RST conversion") Fixes: 1fae869bcf3d ("Documentation: ice: Prepare documentation for RST conversion") Fixes: df69ba43217d ("ionic: Add basic framework for IONIC Network device driver") Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Acked-by: Shannon Nelson <snelson@pensando.io> Acked-by: David S. Miller <davem@davemloft.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: it_IT: maintainer-pgp-guide: Fix reference to "Nitrokey Pro 2"Jonathan Neuschäfer2019-10-031-1/+1
| | | | | | | | | | This fixes the following Sphinx warning: Documentation/translations/it_IT/process/maintainer-pgp-guide.rst:458: WARNING: Unknown target name: "nitrokey pro". Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* doc-rst: Programmatically render MAINTAINERS into ReSTKees Cook2019-10-025-31/+233
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | In order to have the MAINTAINERS file visible in the rendered ReST output, this makes some small changes to the existing MAINTAINERS file to allow for better machine processing, and adds a new Sphinx directive "maintainers-include" to perform the rendering. Features include: - Per-subsystem reference links: subsystem maintainer entries can be trivially linked to both internally and external. For example: https://www.kernel.org/doc/html/latest/process/maintainers.html#secure-computing - Internally referenced .rst files are linked so they can be followed when browsing the resulting rendering. This allows, for example, the future addition of maintainer profiles to be automatically linked. - Field name expansion: instead of the short fields (e.g. "M", "F", "K"), use the indicated inline "full names" for the fields (which are marked with "*"s in MAINTAINERS) so that a rendered subsystem entry is more human readable. Email lists are additionally comma-separated. For example: SECURE COMPUTING Mail: Kees Cook <keescook@chromium.org> Reviewer: Andy Lutomirski <luto@amacapital.net>, Will Drewry <wad@chromium.org> SCM: git git://git.kernel.org/pub/scm/linux/kernel/git/kees/linux.git seccomp Status: Supported Files: kernel/seccomp.c include/uapi/linux/seccomp.h include/linux/seccomp.h tools/testing/selftests/seccomp/* tools/testing/selftests/kselftest_harness.h userspace-api/seccomp_filter Content regex: \bsecure_computing \bTIF_SECCOMP\b Signed-off-by: Kees Cook <keescook@chromium.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* doc-rst: Reduce CSS padding around FieldKees Cook2019-10-021-0/+10
| | | | | | | | | | | | | | | | | Right now any ":Field Name: Field Contents" lines end up with significant padding due to CSS from the "table" CSS which rightly needs padding to make tables readable. However, field lists don't need this as they tend to be stacked together. The future heavy use of fields in the parsed MAINTAINERS file needs this cleaned up, and existing users look better too. Note the needless white space (and misalignment of name/contents) between "Date" and "Author": https://www.kernel.org/doc/html/latest/accounting/psi.html This patch fixes this by lowering the padding with a more specific CSS. Signed-off-by: Kees Cook <keescook@chromium.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: No structured comments in kernel/dma/coherent.cJonathan Corbet2019-10-011-3/+0
| | | | | | | Don't try to extract comments from that file, since there are none to be had and, seemingly, never have been. Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Documentation: document earlycon without options for more platformsChristoph Hellwig2019-10-011-6/+4
| | | | | | | | The earlycon options without arguments is supposed to work on all device tree platforms, not just arm64. Signed-off-by: Christoph Hellwig <hch@lst.de> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: perf: Add imx-ddr to documentation indexAdam Zerella2019-10-012-13/+23
| | | | | | | | | | | Sphinx is currently outputting a warning where the file 'imx-ddr.rst' is not included in the documentation index. Additionally, the code highlighting and doc formatting can be slightly improved. Signed-off-by: Adam Zerella <adam.zerella@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* Merge branch 'dump-struct' into docs-nextJonathan Corbet2019-10-011-5/+6
|\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | André Almeida writes: The current way that scripts/kernel-doc dump structs do not work for nested structs with attributes (e.g. __packed) and without type alias (e.g } alias1;). This is due to the way nested structs members are parsed. Inside dump_struct(), the regex removes attributes and it surrounds whitespaces. After that, it will do a foreach(id) loop for each alias. However, we will have an empty string, and then the split function will return nothing and the foreach will not have any iteration. The code will then jump the loop and the substitution will fail since $newmember is uninitialized. This bug does not happen when the nested struct has no alias and no attribute, since at process_proto_type() a whitespace is inserted in order to ensure that the split will not fail. However, with any attribute, this whitespace will be removed. This patch solves this by replacing attributes with one whitespace, to ensure that will have at least one whitespace. Besides solving this bug at patch 1, I also add support for the ____cacheline_aligned_in_smp atribute at patch 2. For testing and reproducing, create a file `code.h`: /** * struct foobar - description * @number0: desc0 * @number1: desc1 * @number2: desc2 */ struct foo { int number0; struct { int number1; } __packed; struct { int number2; }; }; I've tested with CRYPTO_MINALIGN_ATTR, __attribute__((__aligned__(8))) and __aligned() as well. Now, run the `./script/kernel-doc code.h`, and this is the output: Use of uninitialized value $newmember in substitution (s///) at ./scripts/kernel-doc line 1152, <IN> line 18. .. c:type:: struct foo description **Definition** :: struct foo { int number0; struct { int number1; }; struct { int number2; }; }; **Members** ``number0`` desc0 ``{unnamed_struct}`` anonymous ``number2`` desc2 The output will not display the member number1 and will also display an uninitialized warning. Running after the patch will get rid of the warning and also display the description for number1: [...] **Members** ``number0`` desc0 ``{unnamed_struct}`` anonymous ``number1`` desc1 ``{unnamed_struct}`` anonymous ``number2`` desc2 To test patch [2/2], just replace __packed for ____cacheline_aligned_in_smp and compare how, at the previous stage the script believes ____cacheline... is an alias for the struct and after the patch it is removed just as the others attributes. Finally, I have compared the output of "make htmldocs" with and without this patch. No new warning were found and one warning regarding ____cacheline_aligned_in_smp at include/linux/netdevice.h was removed.
| * kernel-doc: add support for ____cacheline_aligned_in_smp attributeAndré Almeida2019-10-011-1/+2
| | | | | | | | | | | | | | | | | | | | Subroutine dump_struct uses type attributes to check if the struct syntax is valid. Then, it removes all attributes before using it for output. `____cacheline_aligned_in_smp` is an attribute that is not included in both steps. Add it, since it is used by kernel structs. Signed-off-by: André Almeida <andrealmeid@collabora.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
| * kernel-doc: fix processing nested structs with attributesAndré Almeida2019-10-011-4/+4
|/ | | | | | | | | | | | | | | | The current regular expression for strip attributes of structs (and for nested ones as well) also removes all whitespaces that may surround the attribute. After that, the code will split structs and iterate for each symbol separated by comma at the end of struct definition (e.g. "} alias1, alias2;"). However, if the nested struct does not have any alias and has an attribute, it will result in a empty string at the closing bracket (e.g "};"). This will make the split return nothing and $newmember will keep uninitialized. Fix that, by ensuring that the attribute substitution will leave at least one whitespace. Signed-off-by: André Almeida <andrealmeid@collabora.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* scripts/sphinx-pre-install: add how to exit virtualenv usage messageShuah Khan2019-10-011-0/+8
| | | | | | | | Add usage message on how to exit the virtualenv after documentation work is done. Signed-off-by: Shuah Khan <skhan@linuxfoundation.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: fix memory.low description in cgroup-v2.rstJon Haslam2019-10-011-3/+3
| | | | | | | | | | | | The current cgroup-v2.rst file contains an incorrect description of when memory is reclaimed from a cgroup that is using the 'memory.low' mechanism. This fix simply corrects the text to reflect the actual implementation. Fixes: 7854207fe954 ("mm/docs: describe memory.low refinements") Signed-off-by: Jon Haslam <jonhaslam@fb.com> Acked-by: Roman Gushchin <guro@fb.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: kmemleak: DEBUG_KMEMLEAK_EARLY_LOG_SIZE changed namesJeremy Cline2019-10-011-1/+1
| | | | | | | | | | | | Commit c5665868183f ("mm: kmemleak: use the memory pool for early allocations") renamed CONFIG_DEBUG_KMEMLEAK_EARLY_LOG_SIZE to CONFIG_DEBUG_KMEMLEAK_MEM_POOL_SIZE. Update the documentation reference to reflect that. Fixes: c5665868183f ("mm: kmemleak: use the memory pool for early allocations") Signed-off-by: Jeremy Cline <jcline@redhat.com> Acked-by: Catalin Marinas <catalin.marinas@arm.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* docs: security: fix section hyperlinkBrendan Jackman2019-10-011-1/+1
| | | | | | | | | The reStructuredText syntax is wrong here; not sure how it was intended but we can just use the section header as an implicit hyperlink target, with a single "outward" underscore. Signed-off-by: Brendan Jackman <bhenryj0117@gmail.com> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* CREDITS: update email address for Martin KepplingerMartin Kepplinger2019-10-011-1/+2
| | | | | | | | Employers change - Linux stays. Also, add my (long time valid) GPG key fingerprint to the contact details. Signed-off-by: Martin Kepplinger <martin.kepplinger@puri.sm> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
* mailmap: add new email address for Martin KepplingerMartin Kepplinger2019-10-011-0/+1
| | | | | | | Include my new email address for tracking my contributions. Signed-off-by: Martin Kepplinger <martin.kepplinger@puri.sm> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
generated by cgit v1.2.3 (git 2.39.1) at 2024-12-27 22:10:21 +0100