From 7d71788735608b1578e3615ff2646d3a089ff0a8 Mon Sep 17 00:00:00 2001 From: Aditya Srivastava Date: Tue, 10 Nov 2020 23:17:49 +0530 Subject: Documentation: include sign off for reverts Currently, we do not have any documentation on commit reverts regarding the requirement of Signed-off-by tag for it. This may be misleading to the users. Evaluating MISSING_SIGN_OFF checkpatch warnings on v4.13..v5.8 showed that 4 out of 11 cases missing a sign-off are revert commits. Add documentation regarding the same to document the community consensus and let readers know. Signed-off-by: Aditya Srivastava Link: https://lore.kernel.org/r/20201110174749.32068-1-yashsri421@gmail.com Signed-off-by: Jonathan Corbet --- Documentation/process/submitting-patches.rst | 2 ++ 1 file changed, 2 insertions(+) (limited to 'Documentation/process') diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst index 83d9a82055a7..fb8261a4be30 100644 --- a/Documentation/process/submitting-patches.rst +++ b/Documentation/process/submitting-patches.rst @@ -404,6 +404,8 @@ then you just add a line saying:: using your real name (sorry, no pseudonyms or anonymous contributions.) This will be done for you automatically if you use ``git commit -s``. +Reverts should also include "Signed-off-by". ``git revert -s`` does that +for you. Some people also put extra tags at the end. They'll just be ignored for now, but you can do this to mark internal company procedures or just -- cgit v1.2.3 From c900acb7dfe1ae1f5ceca75cc1317f4cda0d3276 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Wed, 2 Dec 2020 10:49:38 +0300 Subject: Documentation: fix typos in process/kernel-docs.rst Fix two typos in kernel-docs.rst Signed-off-by: Andrew Klychkov Acked-by: Randy Dunlap Link: https://lore.kernel.org/r/20201202074938.GA35075@spblnx124.lan Signed-off-by: Jonathan Corbet --- Documentation/process/kernel-docs.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/process') diff --git a/Documentation/process/kernel-docs.rst b/Documentation/process/kernel-docs.rst index 64786e50026c..22d9ace5df2a 100644 --- a/Documentation/process/kernel-docs.rst +++ b/Documentation/process/kernel-docs.rst @@ -90,7 +90,7 @@ On-line docs :Date: 2008 :Keywords: patches, review process, types of submissions, basic rules, case studies :Description: This paper gives several experience values on what types of patches - there are and how likley they get merged. + there are and how likely they get merged. :Abstract: [...]. This paper examines some common problems for submitting larger changes and some strategies to avoid problems. @@ -328,7 +328,7 @@ On-line docs block devices, hardware interrupts, scsi, DMA, access to user memory, memory allocation, timers. :Description: A guide designed to help you get up to speed on the - concepts that are not intuitevly obvious, and to document the internal + concepts that are not intuitively obvious, and to document the internal structures of Linux. * Title: **Dynamic Kernels: Modularized Device Drivers** -- cgit v1.2.3 From e0a45cda66423e56d15b219e4da4f4d530cf9236 Mon Sep 17 00:00:00 2001 From: Andrew Klychkov Date: Wed, 2 Dec 2020 10:54:38 +0300 Subject: Documentation: fix typos found in process, dev-tools, and doc-guide subdirectories Fix four typos in kcov.rst, sphinx.rst, clang-format.rst, and embargoed-hardware-issues.rst Signed-off-by: Andrew Klychkov Acked-by: Randy Dunlap Acked-by: Miguel Ojeda Link: https://lore.kernel.org/r/20201202075438.GA35516@spblnx124.lan Signed-off-by: Jonathan Corbet --- Documentation/process/clang-format.rst | 2 +- Documentation/process/embargoed-hardware-issues.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'Documentation/process') diff --git a/Documentation/process/clang-format.rst b/Documentation/process/clang-format.rst index 82676e5a7c6e..1d089a847c1b 100644 --- a/Documentation/process/clang-format.rst +++ b/Documentation/process/clang-format.rst @@ -97,7 +97,7 @@ it can be very useful. There are integrations for many popular text editors. For some of them, like vim, emacs, BBEdit and Visual Studio you can find support built-in. -For instructions, read the appropiate section at: +For instructions, read the appropriate section at: https://clang.llvm.org/docs/ClangFormat.html diff --git a/Documentation/process/embargoed-hardware-issues.rst b/Documentation/process/embargoed-hardware-issues.rst index 43cdc67e4f8e..6f8f36e10e8b 100644 --- a/Documentation/process/embargoed-hardware-issues.rst +++ b/Documentation/process/embargoed-hardware-issues.rst @@ -152,7 +152,7 @@ The disclosing party should provide a list of contacts for all other entities who have already been, or should be, informed about the issue. This serves several purposes: - - The list of disclosed entities allows communication accross the + - The list of disclosed entities allows communication across the industry, e.g. other OS vendors, HW vendors, etc. - The disclosed entities can be contacted to name experts who should -- cgit v1.2.3 From da514157c4f063527204adc8e9642a18a77fccc9 Mon Sep 17 00:00:00 2001 From: Thorsten Leemhuis Date: Fri, 4 Dec 2020 07:43:50 +0100 Subject: docs: make reporting-bugs.rst obsolete Make various places which point to Documentation/admin-guide/reporting-bugs.rst point to Documentation/admin-guide/reporting-issues.rst instead. That document is brand new and as of now is not completely finished. But even at this stage it's a lot more helpful and accurate than reporting-bugs.rst. Hence also add a note to reporting-bugs.rst, telling people they're better off reading reporting-issues.rst instead. reporting-bugs.rst is scheduled for removal once reporting-issues.rst is considered ready. Signed-off-by: Thorsten Leemhuis Link: https://lore.kernel.org/r/3df7c2d16de112b47bb6e6158138608e78562bf5.1607063223.git.linux@leemhuis.info Signed-off-by: Jonathan Corbet --- Documentation/process/howto.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) (limited to 'Documentation/process') diff --git a/Documentation/process/howto.rst b/Documentation/process/howto.rst index 20c9e07e09a4..7a5c105e34d4 100644 --- a/Documentation/process/howto.rst +++ b/Documentation/process/howto.rst @@ -348,11 +348,10 @@ tool. For details on how to use the kernel bugzilla, please see: https://bugzilla.kernel.org/page.cgi?id=faq.html -The file :ref:`admin-guide/reporting-bugs.rst ` -in the main kernel source directory has a good -template for how to report a possible kernel bug, and details what kind -of information is needed by the kernel developers to help track down the -problem. +The file 'Documentation/admin-guide/reporting-issues.rst' in the main kernel +source directory has a good template for how to report a possible kernel bug, +and details what kind of information is needed by the kernel developers to help +track down the problem. Managing bug reports -- cgit v1.2.3