Conduct a sweep across four more process documentation files. Replace informal contractions with formal expressions and fix minor grammatical bugs to ensure a highly professional and accessible tone.
Signed-off-by: Nguyen Duc Thinh <[email protected]> --- Documentation/process/botching-up-ioctls.rst | 2 +- Documentation/process/changes.rst | 20 +++++++++---------- .../code-of-conduct-interpretation.rst | 14 ++++++------- Documentation/process/code-of-conduct.rst | 2 +- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/Documentation/process/botching-up-ioctls.rst b/Documentation/process/botching-up-ioctls.rst index d9f9d4450debb..186749c443fcd 100644 --- a/Documentation/process/botching-up-ioctls.rst +++ b/Documentation/process/botching-up-ioctls.rst @@ -65,7 +65,7 @@ will have a second iteration or at least an extension for any given interface. * Have a plan for extending ioctls with new flags or new fields at the end of the structure. The drm core checks the passed-in size for each ioctl call and zero-extends any mismatches between kernel and userspace. That helps, - but is not a complete solution since newer userspace on older kernels won't + but is not a complete solution since newer userspace on older kernels will not notice that the newly added fields at the end that get ignored. So this still needs a new driver feature flags. diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst index 0aa232b117b54..f9957a5d46edb 100644 --- a/Documentation/process/changes.rst +++ b/Documentation/process/changes.rst @@ -17,14 +17,14 @@ Axel Boldt, Alessandro Sigala, and countless other users all over the Current Minimal Requirements **************************** -Upgrade to at **least** these software revisions before thinking you've -encountered a bug! If you're unsure what version you're currently +Upgrade to at **least** these software revisions before thinking you have +encountered a bug! If you are unsure what version you are currently running, the suggested command should tell you. For a list of the programs -on your system including their version execute ./scripts/ver_linux +on your system, including their versions, execute ./scripts/ver_linux Again, keep in mind that this list assumes you are already functionally running a Linux kernel. Also, not all tools are necessary on all -systems; obviously, if you don't have any PC Card hardware, for example, +systems; obviously, if you do not have any PC Card hardware, for example, you probably do not need to concern yourself with pcmciautils. ====================== =============== ======================================== @@ -83,7 +83,7 @@ Clang/LLVM (optional) The latest formal release of clang and LLVM utils (according to `releases.llvm.org <https://releases.llvm.org>`_) are supported for building -kernels. Older releases aren't guaranteed to work, and we may drop workarounds +kernels. Older releases are not guaranteed to work, and we may drop workarounds from the kernel that were used to support older versions. Please see additional docs on :ref:`Building Linux with Clang/LLVM <kbuild_llvm>`. @@ -222,7 +222,7 @@ documentation via specially-formatted comments near their definitions in the source. These comments can be combined with ReST files in the Documentation/ directory to make enriched documentation, which can then be converted to PostScript, HTML, LaTex, ePUB and PDF files. -In order to convert from ReST format to a format of your choice, you'll need +In order to convert from ReST format to a format of your choice, you will need Sphinx. Util-linux @@ -231,13 +231,13 @@ Util-linux New versions of util-linux provide ``fdisk`` support for larger disks, support new options to mount, recognize more supported partition types, and similar goodies. -You'll probably want to upgrade. +You will probably want to upgrade. Ksymoops -------- If the unthinkable happens and your kernel oopses, you may need the -ksymoops tool to decode it, but in most cases you don't. +ksymoops tool to decode it, but in most cases you do not. It is generally preferred to build the kernel with ``CONFIG_KALLSYMS`` so that it produces readable dumps that can be used as-is (this also produces better output than ksymoops). If for some reason your kernel @@ -255,7 +255,7 @@ E2fsprogs --------- The latest version of ``e2fsprogs`` fixes several bugs in fsck and -debugfs. Obviously, it's a good idea to upgrade. +debugfs. Obviously, it is a good idea to upgrade. JFSutils -------- @@ -306,7 +306,7 @@ udev you may need to:: mknod /dev/cpu/microcode c 10 184 chmod 0644 /dev/cpu/microcode -as root before you can use this. You'll probably also want to +as root before you can use this. You will probably also want to get the user-space microcode_ctl utility to use with this. udev diff --git a/Documentation/process/code-of-conduct-interpretation.rst b/Documentation/process/code-of-conduct-interpretation.rst index 4cdef83606986..2f070ca1880ec 100644 --- a/Documentation/process/code-of-conduct-interpretation.rst +++ b/Documentation/process/code-of-conduct-interpretation.rst @@ -47,7 +47,7 @@ regarding conduct issues. Maintainers should be willing to help when problems occur, and work with others in the community when needed. Do not be afraid to reach out to -the Technical Advisory Board (TAB) or other maintainers if you're +the Technical Advisory Board (TAB) or other maintainers if you are uncertain how to handle situations that come up. It will not be considered a violation report unless you want it to be. If you are uncertain about approaching the TAB or any other maintainers, please @@ -78,7 +78,7 @@ rejecting unsuitable contributions are not viewed as a violation of the Code of Conduct. While maintainers are in general welcoming to newcomers, their capacity -of helping contributors overcome the entry hurdles is limited, so they +to help contributors overcome the entry hurdles is limited, so they have to set priorities. This, also, is not to be seen as a violation of the Code of Conduct. The kernel community is aware of that and provides entry level programs in various forms like kernelnewbies.org. @@ -123,8 +123,8 @@ Enforcement The address listed in the Code of Conduct goes to the Code of Conduct Committee. The exact members receiving these emails at any given time -are listed at https://kernel.org/code-of-conduct.html. Members can not -access reports made before they joined or after they have left the +are listed at https://kernel.org/code-of-conduct.html. Members cannot +access reports submitted before they joined or after they left the committee. The Code of Conduct Committee consists of volunteer community members @@ -147,7 +147,7 @@ Any decisions regarding enforcement recommendations will be brought to the TAB for implementation of enforcement with the relevant maintainers if needed. Once the TAB approves one or more of the measures outlined in the scope of the ban by two-thirds of the members voting for the -measures, the Code of Conduct Committee will enforce the TAB approved +measures, the Code of Conduct Committee will enforce the TAB-approved measures. Any Code of Conduct Committee members serving on the TAB will not vote on the measures. @@ -177,7 +177,7 @@ Unacceptable behaviors often get resolved when individuals acknowledge their behavior and make amends for it in the setting the violation has taken place. The Code of Conduct Committee receives reports about unacceptable behaviors -when they don't get resolved through community discussions. The Code of +when they do not get resolved through community discussions. The Code of Conduct committee takes measures to restore productive and respectful collaboration when an unacceptable behavior has negatively impacted that relationship. @@ -237,7 +237,7 @@ administrators. Any Code of Conduct Committee members serving on the TAB will not vote on the measures. The Code of Conduct Committee is mindful of the negative impact of seeking -public apology and instituting ban could have on individuals. It is also +a public apology and instituting a ban could have on individuals. It is also mindful of the longer term harm to the community that could result from not taking action when such serious public violations occur. diff --git a/Documentation/process/code-of-conduct.rst b/Documentation/process/code-of-conduct.rst index be50294aebd5d..e5e29c068f2b5 100644 --- a/Documentation/process/code-of-conduct.rst +++ b/Documentation/process/code-of-conduct.rst @@ -34,7 +34,7 @@ Examples of unacceptable behavior by participants include: * Public or private harassment * Publishing others’ private information, such as a physical or electronic address, without explicit permission -* Other conduct which could reasonably be considered inappropriate in a +* Other conduct that could reasonably be considered inappropriate in a professional setting -- 2.50.1 (Apple Git-155)
