[PATCH] docs-rst: doc-guide: Minor grammar fixes
While using this guide to learn the new documentation method, I saw a few phrases that I felt could be improved. These small changes improve the grammar and choice of words to further enhance the installation instructions. Signed-off-by: Joel Nider --- Documentation/doc-guide/sphinx.rst | 12 ++-- 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst index 02605ee..e456a4f 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst @@ -27,8 +27,8 @@ Sphinx Install == The ReST markups currently used by the Documentation/ files are meant to be -built with ``Sphinx`` version 1.3 or upper. If you're desiring to build -PDF outputs, it is recommended to use version 1.4.6 or upper. +built with ``Sphinx`` version 1.3 or higher. If you desire to build +PDF output, it is recommended to use version 1.4.6 or higher. There's a script that checks for the Sphinx requirements. Please see :ref:`sphinx-pre-install` for further details. @@ -37,15 +37,15 @@ Most distributions are shipped with Sphinx, but its toolchain is fragile, and it is not uncommon that upgrading it or some other Python packages on your machine would cause the documentation build to break. -A way to get rid of that is to use a different version than the one shipped -on your distributions. In order to do that, it is recommended to install +A way to avoid that is to use a different version than the one shipped +on your distributions. In order to do so, it is recommended to install Sphinx inside a virtual environment, using ``virtualenv-3`` or ``virtualenv``, depending on how your distribution packaged Python 3. .. note:: #) Sphinx versions below 1.5 don't work properly with Python's - docutils version 0.13.1 or upper. So, if you're willing to use + docutils version 0.13.1 or higher. So, if you're willing to use those versions, you should run ``pip install 'docutils==0.12'``. #) It is recommended to use the RTD theme for html output. Depending @@ -82,7 +82,7 @@ output. PDF and LaTeX builds -Such builds are currently supported only with Sphinx versions 1.4 and upper. +Such builds are currently supported only with Sphinx versions 1.4 and higher. For PDF and LaTeX output, you'll also need ``XeLaTeX`` version 3.14159265. -- 2.7.4
Re: [PATCH v4] coding-style: Clarify the expectations around bool
On 2019-01-11 00:48, Jason Gunthorpe wrote:
There has been some confusion since checkpatch started warning about
bool
use in structures, and people have been avoiding using it.
Many people feel there is still a legitimate place for bool in
structures,
so provide some guidance on bool usage derived from the entire thread
that
spawned the checkpatch warning.
Link:
https://lkml.kernel.org/r/ca+55afwvzk1ofb9t2v014ptakfhtvan_zj2dojncy3x6e4u...@mail.gmail.com
Signed-off-by: Joe Perches
Acked-by: Joe Perches
Reviewed-by: Bart Van Assche
Signed-off-by: Jason Gunthorpe
---
Documentation/process/coding-style.rst | 38 +++---
scripts/checkpatch.pl | 13 -
2 files changed, 34 insertions(+), 17 deletions(-)
v4:
- Describe true/false as definitions [Joe]
- Use clearer language for the _Bool explanation [Bart]
- Delete the checkpatch tests [Joe]
diff --git a/Documentation/process/coding-style.rst
b/Documentation/process/coding-style.rst
index b78dd680c03809..db3e030d0df908 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -921,7 +921,37 @@ result. Typical examples would be functions that
return pointers; they use
NULL or the ERR_PTR mechanism to report failure.
-17) Don't re-invent the kernel macros
+17) Using bool
+--
+
+The Linux kernel bool type is an alias for the C99 _Bool type. bool
values can
+only evaluate to 0 or 1, and implicit or explicit conversion to bool
+automatically converts the value to true or false. When using bool
types the
+!! construction is not needed, which eliminates a class of bugs.
+
+When working with bool values the true and false definitions should be
used
+instead of 0 and 1.
A very minor thing. I would suggest to keep consistent, in the
statement, the mapping
between definitions ("true and false [...]") and their correspondent
integer values
("[...] instead of 1 and 0").
In few words, I propose to change "0 and 1" into "1 and 0".
+
+bool function return types and stack variables are always fine to use
whenever
+appropriate. Use of bool is encouraged to improve readability and is
often a
+better option than 'int' for storing boolean values.
+
+Do not use bool if cache line layout or size of the value matters, its
size
+and alignment varies based on the compiled architecture. Structures
that are
+optimized for alignment and size should not use bool.
+
+If a structure has many true/false values, consider consolidating them
into a
+bitfield with 1 bit members, or using an appropriate fixed width type,
such as
+u8.
+
+Similarly for function arguments, many true/false values can be
consolidated
+into a single bitwise 'flags' argument and 'flags' can often a more
readable
+alternative if the call-sites have naked true/false constants.
Of course, English is not my primary language, but it looks to me that
here a "be"
is missing: "[...] and 'flags' can often a more readable alternative
[...]".
+
+Otherwise limited use of bool in structures and arguments can improve
+readability.
I'm going to update the Italian translations for this. Do you want me to
contribute
directly to this patch? Otherwise I will send a dedicated patch later
when this one
get accepted.
Thanks
+18) Don't re-invent the kernel macros
-
The header file include/linux/kernel.h contains a number of macros
that
@@ -944,7 +974,7 @@ need them. Feel free to peruse that header file
to see what else is already
defined that you shouldn't reproduce in your code.
-18) Editor modelines and other cruft
+19) Editor modelines and other cruft
Some editors can interpret configuration information embedded in
source files,
@@ -978,7 +1008,7 @@ own custom mode, or may have some other magic
method for making indentation
work correctly.
-19) Inline assembly
+20) Inline assembly
---
In architecture-specific code, you may need to use inline assembly to
interface
@@ -1010,7 +1040,7 @@ the next instruction in the assembly output:
: /* outputs */ : /* inputs */ : /* clobbers */);
-20) Conditional Compilation
+21) Conditional Compilation
---
Wherever possible, don't use preprocessor conditionals (#if, #ifdef)
in .c
diff --git a/scripts/checkpatch.pl b/scripts/checkpatch.pl
index b737ca9d720441..d62abd032885a1 100755
--- a/scripts/checkpatch.pl
+++ b/scripts/checkpatch.pl
@@ -6368,19 +6368,6 @@ sub process {
}
}
-# check for bool bitfields
- if ($sline =~ /^.\s+bool\s*$Ident\s*:\s*\d+\s*;/) {
- WARN("BOOL_BITFIELD",
-"Avoid using bool as bitfield. Prefer bool
bitfields as
unsigned int or u<8|16|32>\n" . $herecurr);
- }
-
-# check for bool use in .h files
- if ($realfile =~ /\.h$/ &&
- $sline =
Re: [PATCH] docs-rst: doc-guide: Minor grammar fixes
On Sun, Jan 13, 2019 at 03:15:59PM +0200, Joel Nider wrote: > -A way to get rid of that is to use a different version than the one shipped > -on your distributions. In order to do that, it is recommended to install > +A way to avoid that is to use a different version than the one shipped > +on your distributions. In order to do so, it is recommended to install s/on/with/ Other than that, Acked-by: Matthew Wilcox
Re: [PATCH v4] coding-style: Clarify the expectations around bool
On Thu, Jan 10, 2019 at 11:48:13PM +, Jason Gunthorpe wrote: > +The Linux kernel bool type is an alias for the C99 _Bool type. bool values > can > +only evaluate to 0 or 1, and implicit or explicit conversion to bool > +automatically converts the value to true or false. When using bool types the > +!! construction is not needed, which eliminates a class of bugs. > + > +When working with bool values the true and false definitions should be used > +instead of 0 and 1. > + > +bool function return types and stack variables are always fine to use > whenever > +appropriate. Use of bool is encouraged to improve readability and is often a > +better option than 'int' for storing boolean values. It's awkward to start a sentence with a lower case letter. How about rephrasing this paragraph and the following one as: Using bool as the return type of a function or as a variable is always fine when appropriate. It often improves readability and is a better option than int for storing boolean values. Using bool in data structures is more debatable; its size and alignment can vary between architectures. > +Do not use bool if cache line layout or size of the value matters, its size > +and alignment varies based on the compiled architecture. Structures that are > +optimized for alignment and size should not use bool. > + > +If a structure has many true/false values, consider consolidating them into a > +bitfield with 1 bit members, or using an appropriate fixed width type, such > as > +u8.
Re: [GIT PULL] Documentation: Add AFBC modifier usage documentation
Hi Matthew, On Fri, Jan 11, 2019 at 10:13:44AM -0800, Matthew Wilcox wrote: > On Fri, Jan 11, 2019 at 06:07:49PM +, Liviu Dudau wrote: > > Hi Jonathan, > > > > I have a patch adding documentation for the AFBC modifiers supported > > by the DRM framework with an upcoming patch series. Patch has been > > out for review for a while, please pull. > > Nowhere in this email do you say what "AFBC" stands for or is. Intel are > awful for acronyms. ARM are rapidly getting as bad, or worse. Nobody > else cares as deeply about your project as you do. Provide some kind > of clue about what you're doing and why anybody else should care. While your critique is pertinent, I think you're forgetting this is a pull request, not a patch. I didn't think that a pull request for a patch that has been on the mailing list for a while and that contains documentation that explains clearly what "AFBC" stands for (Arm FrameBuffer Compression, for the record) needs to have the additional information inserted there. At least in my experience, pull requests explain why the request has been sent and what patches it contains, not descriptions of what is inside the patches, because those are handled via different methods. Best regards, Liviu -- | I would like to | | fix the world, | | but they're not | | giving me the | \ source code! / --- ¯\_(ツ)_/¯
Re: [GIT PULL] Documentation: Add AFBC modifier usage documentation
On Fri, Jan 11, 2019 at 11:12:34AM -0700, Jonathan Corbet wrote: > On Fri, 11 Jan 2019 18:07:49 + > Liviu Dudau wrote: > > > I have a patch adding documentation for the AFBC modifiers supported > > by the DRM framework with an upcoming patch series. Patch has been > > out for review for a while, please pull. > > > > The include/uapi/drm/drm_fourcc.h change is only a comment pointing > > towards the file's location, I hope this is fine to pull via your tree. > > I guess I can merge this (though I'd rather get it as a patch), but GPU > stuff normally goes up through the DRM tree. Daniel, might you be > planning to grab this one? I thought anything under Documentation goes via your tree. If that's not the case, don't worry, I can push it via drm-misc tree. Best regards, Liviu > > Thanks, > > jon -- | I would like to | | fix the world, | | but they're not | | giving me the | \ source code! / --- ¯\_(ツ)_/¯
Re: [PATCH 1/2 v6] kdump: add the vmcoreinfo documentation
在 2019年01月11日 20:33, Borislav Petkov 写道: > On Thu, Jan 10, 2019 at 08:19:43PM +0800, Lianbo Jiang wrote: >> +init_uts_ns.name.release >> + >> + >> +The version of the Linux kernel. Used to find the corresponding source >> +code from which the kernel has been built. >> + > > ... > >> + >> +init_uts_ns >> +--- >> + >> +This is the UTS namespace, which is used to isolate two specific >> +elements of the system that relate to the uname(2) system call. The UTS >> +namespace is named after the data structure used to store information >> +returned by the uname(2) system call. >> + >> +User-space tools can get the kernel name, host name, kernel release >> +number, kernel version, architecture name and OS type from it. > > Already asked this but no reply so lemme paste my question again: > > "And this document already fulfills its purpose - those two vmcoreinfo > exports are redundant and the first one can be removed. > > And now that we agreed that VMCOREINFO is not an ABI and is very tightly > coupled to the kernel version, init_uts_ns.name.release can be removed, > yes? > > Or is there anything speaking against that?" > Sorry for this, that is my mistake. Thanks for your reminder. I agree on your point of view. But i forgot that i should remove this variable in this post. I would like to remove this variable and post again. Thanks. Lianbo
[PATCH] Documentation: add ibmvmc to toctree(index) and fix warnings
From: Randy Dunlap Fix Sphinx warnings in ibmvmc.rst, add an index.rst file in Documentation/misc-devices/, and insert that index file into the top-level index file. Documentation/misc-devices/ibmvmc.rst:2: WARNING: Explicit markup ends without a blank line; unexpected unindent. Documentation/misc-devices/ibmvmc.rst:: WARNING: document isn't included in any toctree Signed-off-by: Randy Dunlap Cc: Steven Royer Cc: Jonathan Corbet --- Documentation/index.rst |1 + Documentation/misc-devices/ibmvmc.rst |1 + Documentation/misc-devices/index.rst | 17 + 3 files changed, 19 insertions(+) --- lnx-50-rc2.orig/Documentation/misc-devices/ibmvmc.rst +++ lnx-50-rc2/Documentation/misc-devices/ibmvmc.rst @@ -1,4 +1,5 @@ .. SPDX-License-Identifier: GPL-2.0+ + == IBM Virtual Management Channel Kernel Driver (IBMVMC) == --- lnx-50-rc2.orig/Documentation/index.rst +++ lnx-50-rc2/Documentation/index.rst @@ -90,6 +90,7 @@ needed). filesystems/index vm/index bpf/index + misc-devices/index Architecture-specific documentation --- --- /dev/null +++ lnx-50-rc2/Documentation/misc-devices/index.rst @@ -0,0 +1,17 @@ +.. SPDX-License-Identifier: GPL-2.0 + + +Assorted Miscellaneous Devices Documentation + + +This documentation contains information for assorted devices that do not +fit into other categories. + +.. class:: toc-title + + Table of contents + +.. toctree:: + :maxdepth: 2 + + ibmvmc
[PATCH] Documentation: fix coding-style.rst Sphinx warning
From: Randy Dunlap Fix Sphinx warning in coding-style.rst: Documentation/process/coding-style.rst:446: WARNING: Inline interpreted text or phrase reference start-string without end-string. Signed-off-by: Randy Dunlap --- Documentation/process/coding-style.rst |2 +- 1 file changed, 1 insertion(+), 1 deletion(-) --- lnx-50-rc2.orig/Documentation/process/coding-style.rst +++ lnx-50-rc2/Documentation/process/coding-style.rst @@ -443,7 +443,7 @@ In function prototypes, include paramete Although this is not required by the C language, it is preferred in Linux because it is a simple way to add valuable information for the reader. -Do not use the `extern' keyword with function prototypes as this makes +Do not use the ``extern`` keyword with function prototypes as this makes lines longer and isn't strictly necessary.
[PATCH] networking: Documentation: fix snmp_counters.rst Sphinx warnings
From: Randy Dunlap
Fix over 100 documentation warnings in snmp_counter.rst by
extending the underline string lengths and inserting a blank line
after bullet items.
Examples:
Documentation/networking/snmp_counter.rst:1: WARNING: Title overline too short.
Documentation/networking/snmp_counter.rst:14: WARNING: Bullet list ends without
a blank line; unexpected unindent.
Fixes: 2b96547223e3 ("add document for TCP OFO, PAWS and skip ACK counters")
Fixes: 8e2ea53a83df ("add snmp counters document")
Fixes: 712ee16c230f ("add documents for snmp counters")
Fixes: 80cc49507ba4 ("net: Add part of TCP counts explanations in
snmp_counters.rst")
Fixes: b08794a922c4 ("documentation of some IP/ICMP snmp counters")
Signed-off-by: Randy Dunlap
Cc: yupeng
---
Documentation/networking/snmp_counter.rst | 113 +++-
1 file changed, 86 insertions(+), 27 deletions(-)
--- lnx-50-rc2.orig/Documentation/networking/snmp_counter.rst
+++ lnx-50-rc2/Documentation/networking/snmp_counter.rst
@@ -1,16 +1,17 @@
-===
+
SNMP counter
-===
+
This document explains the meaning of SNMP counters.
General IPv4 counters
-
+=
All layer 4 packets and ICMP packets will change these counters, but
these counters won't be changed by layer 2 packets (such as STP) or
ARP packets.
* IpInReceives
+
Defined in `RFC1213 ipInReceives`_
.. _RFC1213 ipInReceives: https://tools.ietf.org/html/rfc1213#page-26
@@ -23,6 +24,7 @@ and so on). It indicates the number of
GRO/LRO.
* IpInDelivers
+
Defined in `RFC1213 ipInDelivers`_
.. _RFC1213 ipInDelivers: https://tools.ietf.org/html/rfc1213#page-28
@@ -33,6 +35,7 @@ supported protocols will be delivered, i
socket, all valid IP packets will be delivered.
* IpOutRequests
+
Defined in `RFC1213 ipOutRequests`_
.. _RFC1213 ipOutRequests: https://tools.ietf.org/html/rfc1213#page-28
@@ -42,6 +45,7 @@ multicast packets, and would always be u
IpExtOutOctets.
* IpExtInOctets and IpExtOutOctets
+
They are Linux kernel extensions, no RFC definitions. Please note,
RFC1213 indeed defines ifInOctets and ifOutOctets, but they
are different things. The ifInOctets and ifOutOctets include the MAC
@@ -49,6 +53,7 @@ layer header size but IpExtInOctets and
only include the IP layer header and the IP layer data.
* IpExtInNoECTPkts, IpExtInECT1Pkts, IpExtInECT0Pkts, IpExtInCEPkts
+
They indicate the number of four kinds of ECN IP packets, please refer
`Explicit Congestion Notification`_ for more details.
@@ -60,6 +65,7 @@ for the same packet, you might find that
IpExtInNoECTPkts counts 2 or more.
* IpInHdrErrors
+
Defined in `RFC1213 ipInHdrErrors`_. It indicates the packet is
dropped due to the IP header error. It might happen in both IP input
and IP forward paths.
@@ -67,6 +73,7 @@ and IP forward paths.
.. _RFC1213 ipInHdrErrors: https://tools.ietf.org/html/rfc1213#page-27
* IpInAddrErrors
+
Defined in `RFC1213 ipInAddrErrors`_. It will be increased in two
scenarios: (1) The IP address is invalid. (2) The destination IP
address is not a local address and IP forwarding is not enabled
@@ -74,6 +81,7 @@ address is not a local address and IP fo
.. _RFC1213 ipInAddrErrors: https://tools.ietf.org/html/rfc1213#page-27
* IpExtInNoRoutes
+
This counter means the packet is dropped when the IP stack receives a
packet and can't find a route for it from the route table. It might
happen when IP forwarding is enabled and the destination IP address is
@@ -81,6 +89,7 @@ not a local address and there is no rout
address.
* IpInUnknownProtos
+
Defined in `RFC1213 ipInUnknownProtos`_. It will be increased if the
layer 4 protocol is unsupported by kernel. If an application is using
raw socket, kernel will always deliver the packet to the raw socket
@@ -89,10 +98,12 @@ and this counter won't be increased.
.. _RFC1213 ipInUnknownProtos: https://tools.ietf.org/html/rfc1213#page-27
* IpExtInTruncatedPkts
+
For IPv4 packet, it means the actual data size is smaller than the
"Total Length" field in the IPv4 header.
* IpInDiscards
+
Defined in `RFC1213 ipInDiscards`_. It indicates the packet is dropped
in the IP receiving path and due to kernel internal reasons (e.g. no
enough memory).
@@ -100,20 +111,23 @@ enough memory).
.. _RFC1213 ipInDiscards: https://tools.ietf.org/html/rfc1213#page-28
* IpOutDiscards
+
Defined in `RFC1213 ipOutDiscards`_. It indicates the packet is
dropped in the IP sending path and due to kernel internal reasons.
.. _RFC1213 ipOutDiscards: https://tools.ietf.org/html/rfc1213#page-28
* IpOutNoRoutes
+
Defined in `RFC1213 ipOutNoRoutes`_. It indicates the packet is
dropped in the IP sending path and no route is found for it.
.. _RFC1213 ipOutNoRoutes: https://tools.ietf.org/html/rfc1213#page-29
ICMP counters
-
+=
* IcmpInMsgs and IcmpOutMsgs
+
Defined by `RFC1213 icmpInMsgs`_ and `RFC1213 icmpOutMsgs`_
.. _R
Re: [PATCH 1/2 v6] kdump: add the vmcoreinfo documentation
在 2019年01月11日 22:56, Borislav Petkov 写道: > On Thu, Jan 10, 2019 at 08:19:43PM +0800, Lianbo Jiang wrote: >> This document lists some variables that export to vmcoreinfo, and briefly >> describles what these variables indicate. It should be instructive for >> many people who do not know the vmcoreinfo. >> >> Suggested-by: Borislav Petkov >> Signed-off-by: Lianbo Jiang >> --- >> Documentation/kdump/vmcoreinfo.txt | 500 + >> 1 file changed, 500 insertions(+) >> create mode 100644 Documentation/kdump/vmcoreinfo.txt > > Ok, below is what I'm going to commit if no one complains. I hope you'd > find some time to work on adding the checkpatch check for patches which > add vmcoreinfo members but do not document them I noticed that the checkpatch was coded in Perl. But i am not familiar with the Perl program language, that would be beyond my ability to do this, i have to learn the Perl program language step by step. :-) > and also remove those vmcoreinfo members which are unused. > Do you mean this one 'KERNEL_IMAGE_SIZE'? Currently unused by Makedumpfile, but used to compute the module virtual address by Crash. I have corrected this issue in VMCOREINFO doc. Thanks. Lianbo > Which should be easy because we don't have to be backwards-compatible > with makedumpfile as this is not an ABI. > > Thx. > > --- > From: Lianbo Jiang > Date: Thu, 10 Jan 2019 20:19:43 +0800 > Subject: [PATCH] kdump: Document kernel data exported in the vmcoreinfo note > > Document data exported in vmcoreinfo and briefly describe its use by > userspace tools.a > > [ bp: heavily massage and redact the text. ] > > Suggested-by: Borislav Petkov > Signed-off-by: Lianbo Jiang > Signed-off-by: Borislav Petkov > Cc: Andrew Morton > Cc: Baoquan He > Cc: Dave Young > Cc: Jonathan Corbet > Cc: Thomas Gleixner > Cc: Vivek Goyal > Cc: ander...@redhat.com > Cc: k-ha...@ab.jp.nec.com > Cc: ke...@lists.infradead.org > Cc: linux-doc@vger.kernel.org > Cc: mi...@redhat.com > Cc: x86-ml > Link: https://lkml.kernel.org/r/20190110121944.6050-2-liji...@redhat.com > --- > Documentation/kdump/vmcoreinfo.txt | 494 + > 1 file changed, 494 insertions(+) > create mode 100644 Documentation/kdump/vmcoreinfo.txt > > diff --git a/Documentation/kdump/vmcoreinfo.txt > b/Documentation/kdump/vmcoreinfo.txt > new file mode 100644 > index ..2dc3797940a3 > --- /dev/null > +++ b/Documentation/kdump/vmcoreinfo.txt > @@ -0,0 +1,494 @@ > + > + VMCOREINFO > + > + > +=== > +What is it? > +=== > + > +VMCOREINFO is a special ELF note section. It contains various > +information from the kernel like structure size, page size, symbol > +values, field offsets, etc. These data are packed into an ELF note > +section and used by user-space tools like crash and makedumpfile to > +analyze a kernel's memory layout. > + > + > +Common variables > + > + > +init_uts_ns.name.release > + > + > +The version of the Linux kernel. Used to find the corresponding source > +code from which the kernel has been built. > + > +PAGE_SIZE > +- > + > +The size of a page. It is the smallest unit of data used by the memory > +management facilities. It is usually 4096 bytes of size and a page is > +aligned on 4096 bytes. Used for computing page addresses. > + > +init_uts_ns > +--- > + > +The UTS namespace which is used to isolate two specific elements of the > +system that relate to the uname(2) system call. It is named after the > +data structure used to store information returned by the uname(2) system > +call. > + > +User-space tools can get the kernel name, host name, kernel release > +number, kernel version, architecture name and OS type from it. > + > +node_online_map > +--- > + > +An array node_states[N_ONLINE] which represents the set of online nodes > +in a system, one bit position per node number. Used to keep track of > +which nodes are in the system and online. > + > +swapper_pg_dir > +- > + > +The global page directory pointer of the kernel. Used to translate > +virtual to physical addresses. > + > +_stext > +-- > + > +Defines the beginning of the text section. In general, _stext indicates > +the kernel start address. Used to convert a virtual address from the > +direct kernel map to a physical address. > + > +vmap_area_list > +-- > + > +Stores the virtual area list. makedumpfile gets the vmalloc start value > +from this variable and its value is necessary for vmalloc translation. > + > +mem_map > +--- > + > +Physical addresses are translated to struct pages by treating them as > +an index into the mem_map array. Right-shifting a physical address > +PAGE_SHIFT bits converts it into a page frame number which is an index > +into that me
Re: [PATCH v10 01/12] dt-bindings: Add a document of PECI subsystem
On Tue, 8 Jan 2019 at 08:11, Jae Hyun Yoo wrote: > > This commit adds a document of generic PECI bus, adapter and client > driver. > > Cc: Rob Herring > Cc: Mark Rutland > Cc: Andrew Jeffery > Cc: Joel Stanley > Signed-off-by: Jae Hyun Yoo > Reviewed-by: Haiyue Wang > Reviewed-by: James Feist > Reviewed-by: Vernon Mauery > Reviewed-by: Rob Herring Reviewed-by: Joel Stanley
[PATCH] docs: Bump version to 5.x
This shows up in the index of https://www.kernel.org/doc/html/latest/ so
I figured it should be updated.
Fixes: bfeffd15528 ("Linux 5.0-rc1")
Signed-off-by: Joel Stanley
--
We could also remove the version number instead of applying this patch.
---
Documentation/admin-guide/README.rst | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/Documentation/admin-guide/README.rst
b/Documentation/admin-guide/README.rst
index 0797eec76be1..a09baa324951 100644
--- a/Documentation/admin-guide/README.rst
+++ b/Documentation/admin-guide/README.rst
@@ -1,9 +1,9 @@
.. _readme:
-Linux kernel release 4.x
[PATCH v2] docs-rst: doc-guide: Minor grammar fixes
While using this guide to learn the new documentation method, I saw a few phrases that I felt could be improved. These small changes improve the grammar and choice of words to further enhance the installation instructions. Signed-off-by: Joel Nider Acked-by: Matthew Wilcox --- v2: address Matthew's comment Documentation/doc-guide/sphinx.rst | 12 ++-- 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst index 02605ee..c039224 100644 --- a/Documentation/doc-guide/sphinx.rst +++ b/Documentation/doc-guide/sphinx.rst @@ -27,8 +27,8 @@ Sphinx Install == The ReST markups currently used by the Documentation/ files are meant to be -built with ``Sphinx`` version 1.3 or upper. If you're desiring to build -PDF outputs, it is recommended to use version 1.4.6 or upper. +built with ``Sphinx`` version 1.3 or higher. If you desire to build +PDF output, it is recommended to use version 1.4.6 or higher. There's a script that checks for the Sphinx requirements. Please see :ref:`sphinx-pre-install` for further details. @@ -37,15 +37,15 @@ Most distributions are shipped with Sphinx, but its toolchain is fragile, and it is not uncommon that upgrading it or some other Python packages on your machine would cause the documentation build to break. -A way to get rid of that is to use a different version than the one shipped -on your distributions. In order to do that, it is recommended to install +A way to avoid that is to use a different version than the one shipped +with your distributions. In order to do so, it is recommended to install Sphinx inside a virtual environment, using ``virtualenv-3`` or ``virtualenv``, depending on how your distribution packaged Python 3. .. note:: #) Sphinx versions below 1.5 don't work properly with Python's - docutils version 0.13.1 or upper. So, if you're willing to use + docutils version 0.13.1 or higher. So, if you're willing to use those versions, you should run ``pip install 'docutils==0.12'``. #) It is recommended to use the RTD theme for html output. Depending @@ -82,7 +82,7 @@ output. PDF and LaTeX builds -Such builds are currently supported only with Sphinx versions 1.4 and upper. +Such builds are currently supported only with Sphinx versions 1.4 and higher. For PDF and LaTeX output, you'll also need ``XeLaTeX`` version 3.14159265. -- 2.7.4
Re: [PATCH v2] docs-rst: doc-guide: Minor grammar fixes
On Mon, Jan 14, 2019 at 09:14:59AM +0200, Joel Nider wrote: > While using this guide to learn the new documentation method, I saw > a few phrases that I felt could be improved. These small changes > improve the grammar and choice of words to further enhance the > installation instructions. > > Signed-off-by: Joel Nider > Acked-by: Matthew Wilcox Acked-by: Mike Rapoport > --- > v2: address Matthew's comment > > Documentation/doc-guide/sphinx.rst | 12 ++-- > 1 file changed, 6 insertions(+), 6 deletions(-) > > diff --git a/Documentation/doc-guide/sphinx.rst > b/Documentation/doc-guide/sphinx.rst > index 02605ee..c039224 100644 > --- a/Documentation/doc-guide/sphinx.rst > +++ b/Documentation/doc-guide/sphinx.rst > @@ -27,8 +27,8 @@ Sphinx Install > == > > The ReST markups currently used by the Documentation/ files are meant to be > -built with ``Sphinx`` version 1.3 or upper. If you're desiring to build > -PDF outputs, it is recommended to use version 1.4.6 or upper. > +built with ``Sphinx`` version 1.3 or higher. If you desire to build > +PDF output, it is recommended to use version 1.4.6 or higher. > > There's a script that checks for the Sphinx requirements. Please see > :ref:`sphinx-pre-install` for further details. > @@ -37,15 +37,15 @@ Most distributions are shipped with Sphinx, but its > toolchain is fragile, > and it is not uncommon that upgrading it or some other Python packages > on your machine would cause the documentation build to break. > > -A way to get rid of that is to use a different version than the one shipped > -on your distributions. In order to do that, it is recommended to install > +A way to avoid that is to use a different version than the one shipped > +with your distributions. In order to do so, it is recommended to install > Sphinx inside a virtual environment, using ``virtualenv-3`` > or ``virtualenv``, depending on how your distribution packaged Python 3. > > .. note:: > > #) Sphinx versions below 1.5 don't work properly with Python's > - docutils version 0.13.1 or upper. So, if you're willing to use > + docutils version 0.13.1 or higher. So, if you're willing to use >those versions, you should run ``pip install 'docutils==0.12'``. > > #) It is recommended to use the RTD theme for html output. Depending > @@ -82,7 +82,7 @@ output. > PDF and LaTeX builds > > > -Such builds are currently supported only with Sphinx versions 1.4 and upper. > +Such builds are currently supported only with Sphinx versions 1.4 and higher. > > For PDF and LaTeX output, you'll also need ``XeLaTeX`` version 3.14159265. > > -- > 2.7.4 > -- Sincerely yours, Mike.
