- 16 Sep, 2020 8 commits
-
-
Stephen Kitt authored
Following the structure used in sysctl/kernel.rst, this updates abi.rst to use ReStructured Text more fully and updates the entries to match current kernels: * the list of files is now the table of contents; * links are used to point to other documentation and other sections; * all the existing entries are no longer present, so this removes them; * document vsyscall32. Mentions of the kernel version are dropped. Since the document is entirely rewritten, I've replaced the copyright statement. Signed-off-by:Stephen Kitt <steve@sk2.org> Link: https://lore.kernel.org/r/20200911190152.29730-1-steve@sk2.orgSigned-off-by:
Jonathan Corbet <corbet@lwn.net>
-
Jonathan Cameron authored
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` is an attribute that is not included in both steps. Add it, since it is used by kernel structs. Based on previous patch to add ____cacheline_aligned_in_smp. Motivated by patches to reorder this attribute to before the variable name. Whilst we could do that in all cases, that would be a massive change and it is more common in the kernel to place this particular attribute after the variable name. A quick grep suggests approximately 400 instances of which 341 have this attribute just before a semicolon and hence after the variable name. Signed-off-by:
Jonathan Cameron <Jonathan.Cameron@huawei.com> Cc: Lee Jones <lee.jones@linaro.org> Link: https://lore.kernel.org/r/20200910185415.653139-1-jic23@kernel.orgSigned-off-by:
-
Tian Tao authored
arm64 also supports disable hugeiomap,updated documentation. Signed-off-by:
Tian Tao <tiantao6@hisilicon.com> Link: https://lore.kernel.org/r/1599740386-47210-1-git-send-email-tiantao6@hisilicon.comSigned-off-by:
-
Ralph Campbell authored
The migrate_vma_setup(), migrate_vma_pages(), and migrate_vma_finalize() API usage by device drivers is not well documented. Add a description for how device drivers are expected to use it. Signed-off-by:
Ralph Campbell <rcampbell@nvidia.com> Reviewed-by:
Alistair Popple <apopple@nvidia.com> Link: https://lore.kernel.org/r/20200909212956.20104-1-rcampbell@nvidia.comSigned-off-by:
-
Stephen Boyd authored
Document the notes file in sysfs as the running vmlinux's .note section in binary format. Hopefully this helps someone like me realize the kernel exposes the note section in sysfs in the future. Take the date from when the file was introduced. It's been a while so presumably this is stable and not testing material. Signed-off-by:
Stephen Boyd <swboyd@chromium.org> Link: https://lore.kernel.org/r/20200909063752.931283-1-swboyd@chromium.orgSigned-off-by:
-
Nícolas F. R. A. Prado authored
The syntax to cross-reference between documentation pages wasn't documented anywhere. Document the cross-referencing using the new automarkup for Documentation/... and also Sphinx's doc directive for using relative paths. Signed-off-by:
Nícolas F. R. A. Prado <nfraprado@protonmail.com> Link: https://lore.kernel.org/r/20200911133339.327721-4-nfraprado@protonmail.comSigned-off-by:
-
Nícolas F. R. A. Prado authored
Cross-referencing to other documentation pages is possible using the :doc:`doc-file` directive from Sphinx. Add automatic markup for references to other documentation pages in the format Documentation/subfolder/doc-file.rst (the extension being optional). This requires that the path be passed all the way from the Documentation folder, which can be longer than passing a relative path through the :doc: directive, but avoids the markup, making the text cleaner when read in plain text. Signed-off-by:
-
Nícolas F. R. A. Prado authored
The automarkup script previously matched expressions and substituted them with markup to enable automatic cross-reference all in the same function. Split the expression matching iteration and the markup substitution into different functions to make it easier to add new regular expressions and functions to treat each of them. Signed-off-by:
-
- 11 Sep, 2020 1 commit
-
-
Mauro Carvalho Chehab authored
There's a warning at iio.h kernel-doc markup: ./include/linux/iio/iio.h:644: WARNING: Unknown target name: "devm". Because it is using {devm_}foo notation. Well, this is not a valid kernel-doc notation. Also, it prevents creating hyperlinks to other documentation functions. So, replace it to a better notation. Signed-off-by:Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Acked-by:
-
- 10 Sep, 2020 12 commits
-
-
Mauro Carvalho Chehab authored
There are two broken references at submitting-patches.rst: Documentation/process/submitting-patches.rst:240: WARNING: undefined label: security-bugs (if the link has no caption the label must precede a section header) Documentation/process/submitting-patches.rst:336: WARNING: undefined label: documentation/process/email-clients.rst (if the link has no caption the label must precede a section header) Those are due to some recent renames and file moves. It turns that maintaining :ref: is currently harder than using :doc:, as we now have a script to help checking such references. So, replace :ref: to :doc: there, making them to point to the current file name. Signed-off-by:
-
Mauro Carvalho Chehab authored
Fix those warnings: Documentation/driver-api/dma-buf.rst:182: WARNING: Title underline too short. Indefinite DMA Fences ~~~~~~~~~~~~~~~~~~~~ Documentation/driver-api/dma-buf.rst:88: WARNING: Unknown target name: "fence poll support". The first one is due to a shorter markup. The second one is because the chapter name was wrong. Signed-off-by:
-
Mauro Carvalho Chehab authored
Currently, sphinx emits one warning on this file: Documentation/driver-api/soundwire/stream.rst:522: WARNING: Block quote ends without a blank line; unexpected unindent. That's due to some extra spaces before the title of a chapter. Yet, the list afterwards is missing identation. So, address both issues. Signed-off-by:
-
Mauro Carvalho Chehab authored
There are some warnings: Documentation/virt/kvm/api.rst:4354: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/virt/kvm/api.rst:4358: WARNING: Definition list ends without a blank line; unexpected unindent. Documentation/virt/kvm/api.rst:4363: WARNING: Definition list ends without a blank line; unexpected unindent. Produced by the lack of identation on a single line. That caused the literal block to end prematurely. Signed-off-by:
-
Mauro Carvalho Chehab authored
Fix those warnings: Documentation/watch_queue.rst:108: WARNING: Inline literal start-string without end-string. Documentation/watch_queue.rst:108: WARNING: Inline emphasis start-string without end-string. Documentation/watch_queue.rst:108: WARNING: Inline emphasis start-string without end-string. Documentation/watch_queue.rst:108: WARNING: Inline emphasis start-string without end-string. Documentation/watch_queue.rst:185: WARNING: Inline literal start-string without end-string. Documentation/watch_queue.rst:185: WARNING: Inline emphasis start-string without end-string. Documentation/watch_queue.rst:184: WARNING: Inline emphasis start-string without end-string. The problem here is that the ``notation`` doesn't accept multi lines. So, replace it to a code block using: :: notation Signed-off-by: -
Mauro Carvalho Chehab authored
There were some new file additions for Kernel 5.7 and 5.8 that weren't added at the corresponding index file. Signed-off-by:
-
Mauro Carvalho Chehab authored
sysfs.txt was converted and renamed to sysfs.rst. Update device_attr_show.cocci script accordingly. Signed-off-by:
-
Mauro Carvalho Chehab authored
ethernet/qlogic/LICENSE.qla3xxx -> qlogic/LICENSE.qla3xxx Signed-off-by:
-
Mauro Carvalho Chehab authored
This patch was moved out of staging. Fixes: 2165b82f ("docs: Move kprobes.rst from staging/ to trace/") Signed-off-by:
-
Mauro Carvalho Chehab authored
The name of the directory where the schedule docs are stored are wrong on those files. Signed-off-by:
Valentin Schneider <valentin.schneider@arm.com> Link: https://lore.kernel.org/r/a32c2bba17aa69dc18670b7de1a3a35bfa1e1f88.1599660067.git.mchehab+huawei@kernel.orgSigned-off-by:
-
Mauro Carvalho Chehab authored
This should solve bad error reports like this one: ./include/linux/iio/iio.h:0: WARNING: Unknown target name: "devm". Signed-off-by:
-
Mauro Carvalho Chehab authored
The default way of building documentation is to use Sphinx toolchain installed via pip, inside the Kernel tree main directory. That's what's recommended by: scripts/sphinx-pre-install As it usually provides a better version of this package than the one installed, specially on LTS distros. So, add the directories created by running the commands suggested by the script. Signed-off-by:
-
- 09 Sep, 2020 12 commits
-
-
Jonathan Neuschäfer authored
This prevents the chapter headings from showing up in the table of contents in filesystems/index.html. Note that I didn't pick "UBIFS Authentication" as the document title, because there is a chapter of the same name, and Sphinx complains about multiple headings with the same name: /.../Documentation/filesystems/ubifs-authentication.rst:207: WARNING: duplicate label filesystems/ubifs-authentication:ubifs authentication, other instance in /.../Documentation/filesystems/ubifs-authentication.rst Remove the :orphan: tag, as the document has been included into the toctree. Signed-off-by:
Jonathan Neuschäfer <j.neuschaefer@gmx.net> Link: https://lore.kernel.org/r/20200905204326.1378339-3-j.neuschaefer@gmx.netSigned-off-by:
-
Jonathan Neuschäfer authored
Signed-off-by:
-
Barry Song authored
fourV CPUs should be four CPUs. Signed-off-by:
Barry Song <song.bao.hua@hisilicon.com> Link: https://lore.kernel.org/r/20200904101902.29560-1-song.bao.hua@hisilicon.comSigned-off-by:
-
Lars Poeschel authored
Rename function name to the actual name referenced in struct iio_sw_trigger_ops. Signed-off-by:
Lars Poeschel <poeschel@lemonage.de> Link: https://lore.kernel.org/r/20200904091911.269715-1-poeschel@lemonage.deSigned-off-by:
-
Ralph Campbell authored
Add Sphinx reference links to HMM and CPUSETS, and numerous small editorial changes to make the page_migration.rst document more readable. Signed-off-by:
Randy Dunlap <rdunlap@infradead.org> Link: https://lore.kernel.org/r/20200902225247.15213-1-rcampbell@nvidia.comSigned-off-by:
-
Gustavo A. R. Silva authored
Update information in the zero-length and one-element arrays section and illustrate how to make use of the new flex_array_size() helper, together with struct_size() and a flexible-array member. Signed-off-by:
Gustavo A. R. Silva <gustavoars@kernel.org> Acked-by:
Kees Cook <keescook@chromium.org> Link: https://lore.kernel.org/r/20200901010949.GA21398@embeddedorSigned-off-by:
-
Randy Dunlap authored
Add to Documentation/process/submit-checklist.rst that patch submitters should run "make htmldocs" and verify that any Documentation/ changes (patches) are clean (no new warnings/errors). Signed-off-by:
Mike Rapoport <rppt@linux.ibm.com> Link: https://lore.kernel.org/r/cf5bbdf5-03ff-0606-a6d4-ca196d90aee9@infradead.orgSigned-off-by:
-
Denis Efremov authored
Commit a4232963 ("driver-core: Move kobj_to_dev from genhd.h to device.h") introduced kobj_to_dev() function. Signed-off-by:
Denis Efremov <efremov@linux.com> Link: https://lore.kernel.org/r/20200830144135.6956-1-efremov@linux.comSigned-off-by:
-
Denis Efremov authored
Commit 15322a0d ("lsm: remove current_security()") removed current_security() from the sources. Signed-off-by:
-
Coly Li authored
bcache.rst is from the original bcache.txt which was merged in mainline kernel v3.10. There are a few things changed in the past 7 years. This patch updates bache.rst documents in following content, - Update bcache-tools git repo to, https://git.kernel.org/pub/scm/linux/kernel/git/colyli/bcache-tools.git/ - Update bcache kernel tree to mainline kernel tree, https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/ - make-bcache util is replaced by the unified bcache util, `make-bcache` now can be performed by `bcache make` Signed-off-by:
Coly Li <colyli@suse.de> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Kent Overstreet <kent.overstreet@gmail.com> Link: https://lore.kernel.org/r/20200821151354.16727-1-colyli@suse.deSigned-off-by:
-
Coly Li authored
The parameters in command examples for tpm2_createprimary and tpm2_evictcontrol are outdated, people (like me) are not able to create trusted key by these command examples. This patch updates the parameters of command example tpm2_createprimary and tpm2_evictcontrol in trusted-encrypted.rst. With Linux kernel v5.8 and tpm2-tools-4.1, people can create a trusted key by following the examples in this document. Signed-off-by:
Jarkko Sakkinen <jarkko.sakkinen@linux.intel.com> Reviewed-by:
Stefan Berger <stefanb@linux.ibm.com> Cc: Dan Williams <dan.j.williams@intel.com> Cc: James Bottomley <jejb@linux.ibm.com> Cc: Jason Gunthorpe <jgg@ziepe.ca> Cc: Mimi Zohar <zohar@linux.ibm.com> Cc: Peter Huewe <peterhuewe@gmx.de> Link: https://lore.kernel.org/r/20200821135356.15737-1-colyli@suse.deSigned-off-by:
-
Connor Kuehl authored
The actual symbol that is exported and usable is 'KVM_MEMORY_ENCRYPT_OP', not 'KVM_MEM_ENCRYPT_OP' $ git grep -l KVM_MEM_ENCRYPT_OP Documentation/virt/kvm/amd-memory-encryption.rst $ git grep -l KVM_MEMORY_ENCRYPT_OP Documentation/virt/kvm/api.rst arch/x86/kvm/x86.c include/uapi/linux/kvm.h tools/include/uapi/linux/kvm.h While we're in there, update the KVM API category for KVM_MEMORY_ENCRYPT_OP. It is called on a VM file descriptor. Signed-off-by:
Connor Kuehl <ckuehl@redhat.com> Link: https://lore.kernel.org/r/20200819211952.251984-1-ckuehl@redhat.comSigned-off-by:
-
- 04 Sep, 2020 1 commit
-
-
Jonathan Corbet authored
The Sphinx 3.x upgrade broke a number of things in our special "cdomain" module that are not easy to fix. For now, just disable that module for the 3.x build and put out a warning that the build will not be perfect. Signed-off-by:
-
- 03 Sep, 2020 6 commits
-
-
Drew DeVault authored
Git is fairly ubiquitous these days, and the additional information in this documentation for preparing patches without it is not especially relevant anymore and may serve to confuse new contributors. The git request-pull comments were also removed, given that it is not a tool well-suited to novice contributors, nor do maintainers especially appreciate receiving unexpected request-pulls from new contributors. Signed-off-by:
Drew DeVault <sir@cmpwn.com> Link: https://lore.kernel.org/r/20200903160545.83185-5-sir@cmpwn.comSigned-off-by:
-
Drew DeVault authored
The repeated sign-offs necessary when a subsystem maintainer modifies an incoming patch has been moved from submitting-patches.rst to Documentation/maintainer, since the affairs of a subsystem maintainer are not especially relevant to someone reading a guide for how to submit their first patch. Signed-off-by:
-
Drew DeVault authored
This adds a link to https://useplaintext.email to email-clients.rst, which is a more exhaustive resource on configuring various mail clients for plain text use. submitting-patches.rst is also updated to direct readers to email-clients.rst to equip new contributors with the requisite knowledge to become a good participant on the mailing lists. Signed-off-by:
-
Drew DeVault authored
This follows similar changes throughout Documentation; these numbers tend to get outdated and are not especially useful. Signed-off-by:
-
Nícolas F. R. A. Prado authored
Update text and examples in the "Cross-referencing from reStructuredText" section to reflect that no additional syntax is needed anymore. Signed-off-by:
-
Nícolas F. R. A. Prado authored
In order to cross-reference C types in the documentation, Sphinx requires the syntax :c:type:`type_name`, or even :c:type:`struct type_name <type_name>` in order to have the link text different from the target text. Extend automarkup to enable automatic cross-reference of C types by matching any "struct|union|enum|typedef type_name" expression. This makes the documentation's plain text cleaner and adds cross-reference to types without any additional effort by the author. Signed-off-by:
-
