linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH 1/6] Documentation: coding-style: Escape \n\t to fix HTML rendering
@ 2017-05-15 13:40 Jonathan Neuschäfer
  2017-05-15 13:40 ` [PATCH 2/6] Documentation: kernel-docs: Move vfs.txt under "Docs at the Linux Kernel tree" Jonathan Neuschäfer
                   ` (4 more replies)
  0 siblings, 5 replies; 6+ messages in thread
From: Jonathan Neuschäfer @ 2017-05-15 13:40 UTC (permalink / raw)
  To: linux-doc; +Cc: linux-kernel, Jonathan Neuschäfer

Without this patch, Sphinx renders the sentence as follows, thus hiding
the backslashes:

	[...] end each string except the last with <cite>nt</cite> to
	properly indent the next instruction [...]

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/process/coding-style.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/process/coding-style.rst b/Documentation/process/coding-style.rst
index d20d52a4d812..7710c7e0240c 100644
--- a/Documentation/process/coding-style.rst
+++ b/Documentation/process/coding-style.rst
@@ -980,7 +980,7 @@ do so, though, and doing so unnecessarily can limit optimization.
 
 When writing a single inline assembly statement containing multiple
 instructions, put each instruction on a separate line in a separate quoted
-string, and end each string except the last with \n\t to properly indent the
+string, and end each string except the last with ``\n\t`` to properly indent the
 next instruction in the assembly output:
 
 .. code-block:: c
-- 
2.11.0

^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH 2/6] Documentation: kernel-docs: Move vfs.txt under "Docs at the Linux Kernel tree"
  2017-05-15 13:40 [PATCH 1/6] Documentation: coding-style: Escape \n\t to fix HTML rendering Jonathan Neuschäfer
@ 2017-05-15 13:40 ` Jonathan Neuschäfer
  2017-05-15 13:40 ` [PATCH 3/6] Documentation: kernel-docs: Remove "Here is its" at the end of lines Jonathan Neuschäfer
                   ` (3 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: Jonathan Neuschäfer @ 2017-05-15 13:40 UTC (permalink / raw)
  To: linux-doc; +Cc: linux-kernel, Jonathan Neuschäfer

It's unneccessary to point to an external mirror of the Documentation
directory. Also, drop the date field, because in-kernel documentation is
continually updated.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/process/kernel-docs.rst | 23 +++++++++++------------
 1 file changed, 11 insertions(+), 12 deletions(-)

diff --git a/Documentation/process/kernel-docs.rst b/Documentation/process/kernel-docs.rst
index 05a7857a4a83..6ff8291194ee 100644
--- a/Documentation/process/kernel-docs.rst
+++ b/Documentation/process/kernel-docs.rst
@@ -84,6 +84,17 @@ The Sphinx books should be built with ``make {htmldocs | pdfdocs | epubdocs}``.
         different". Freely redistributable under the conditions of the GNU
         General Public License.
 
+    * Title: **Overview of the Virtual File System**
+
+      :Author: Richard Gooch.
+      :Location: Documentation/filesystems/vfs.txt
+      :Keywords: VFS, File System, mounting filesystems, opening files,
+        dentries, dcache.
+      :Description: Brief introduction to the Linux Virtual File System.
+        What is it, how it works, operations taken when opening a file or
+        mounting a file system and description of important data
+        structures explaining the purpose of each of their entries.
+
 On-line docs
 ------------
 
@@ -127,18 +138,6 @@ On-line docs
         [...]. This paper examines some common problems for
         submitting larger changes and some strategies to avoid problems.
 
-    * Title: **Overview of the Virtual File System**
-
-      :Author: Richard Gooch.
-      :URL: http://www.mjmwired.net/kernel/Documentation/filesystems/vfs.txt
-      :Date: 2007
-      :Keywords: VFS, File System, mounting filesystems, opening files,
-        dentries, dcache.
-      :Description: Brief introduction to the Linux Virtual File System.
-        What is it, how it works, operations taken when opening a file or
-        mounting a file system and description of important data
-        structures explaining the purpose of each of their entries.
-
     * Title: **Linux Device Drivers, Third Edition**
 
       :Author: Jonathan Corbet, Alessandro Rubini, Greg Kroah-Hartman
-- 
2.11.0

^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH 3/6] Documentation: kernel-docs: Remove "Here is its" at the end of lines
  2017-05-15 13:40 [PATCH 1/6] Documentation: coding-style: Escape \n\t to fix HTML rendering Jonathan Neuschäfer
  2017-05-15 13:40 ` [PATCH 2/6] Documentation: kernel-docs: Move vfs.txt under "Docs at the Linux Kernel tree" Jonathan Neuschäfer
@ 2017-05-15 13:40 ` Jonathan Neuschäfer
  2017-05-15 13:40 ` [PATCH 4/6] Documentation: Remove outdated info about -git patches Jonathan Neuschäfer
                   ` (2 subsequent siblings)
  4 siblings, 0 replies; 6+ messages in thread
From: Jonathan Neuschäfer @ 2017-05-15 13:40 UTC (permalink / raw)
  To: linux-doc; +Cc: linux-kernel, Jonathan Neuschäfer

Before commit 9e03ea7f683e ("Documentation/kernel-docs.txt: convert it to
ReST markup"), it read:

       Description: Linux Journal Kernel Korner article. Here is its
       abstract: "..."

In Sphinx' HTML formatting, however, the "Here is its" doesn't make
sense anymore, because the "Abstract:" is clearly separated.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/process/kernel-docs.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/process/kernel-docs.rst b/Documentation/process/kernel-docs.rst
index 6ff8291194ee..a9aad381c3a4 100644
--- a/Documentation/process/kernel-docs.rst
+++ b/Documentation/process/kernel-docs.rst
@@ -356,7 +356,7 @@ On-line docs
       :URL: http://www.linuxjournal.com/article.php?sid=2391
       :Date: 1997
       :Keywords: RAID, MD driver.
-      :Description: Linux Journal Kernel Korner article. Here is its
+      :Description: Linux Journal Kernel Korner article.
       :Abstract: *A description of the implementation of the RAID-1,
         RAID-4 and RAID-5 personalities of the MD device driver in the
         Linux kernel, providing users with high performance and reliable,
@@ -381,7 +381,7 @@ On-line docs
       :Date: 1996
       :Keywords: device driver, module, loading/unloading modules,
         allocating resources.
-      :Description: Linux Journal Kernel Korner article. Here is its
+      :Description: Linux Journal Kernel Korner article.
       :Abstract: *This is the first of a series of four articles
         co-authored by Alessandro Rubini and Georg Zezchwitz which present
         a practical approach to writing Linux device drivers as kernel
@@ -397,7 +397,7 @@ On-line docs
       :Keywords: character driver, init_module, clean_up module,
         autodetection, mayor number, minor number, file operations,
         open(), close().
-      :Description: Linux Journal Kernel Korner article. Here is its
+      :Description: Linux Journal Kernel Korner article.
       :Abstract: *This article, the second of four, introduces part of
         the actual code to create custom module implementing a character
         device driver. It describes the code for module initialization and
@@ -410,7 +410,7 @@ On-line docs
       :Date: 1996
       :Keywords: read(), write(), select(), ioctl(), blocking/non
         blocking mode, interrupt handler.
-      :Description: Linux Journal Kernel Korner article. Here is its
+      :Description: Linux Journal Kernel Korner article.
       :Abstract: *This article, the third of four on writing character
         device drivers, introduces concepts of reading, writing, and using
         ioctl-calls*.
@@ -421,7 +421,7 @@ On-line docs
       :URL: http://www.linuxjournal.com/article.php?sid=1222
       :Date: 1996
       :Keywords: interrupts, irqs, DMA, bottom halves, task queues.
-      :Description: Linux Journal Kernel Korner article. Here is its
+      :Description: Linux Journal Kernel Korner article.
       :Abstract: *This is the fourth in a series of articles about
         writing character device drivers as loadable kernel modules. This
         month, we further investigate the field of interrupt handling.
-- 
2.11.0

^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH 4/6] Documentation: Remove outdated info about -git patches
  2017-05-15 13:40 [PATCH 1/6] Documentation: coding-style: Escape \n\t to fix HTML rendering Jonathan Neuschäfer
  2017-05-15 13:40 ` [PATCH 2/6] Documentation: kernel-docs: Move vfs.txt under "Docs at the Linux Kernel tree" Jonathan Neuschäfer
  2017-05-15 13:40 ` [PATCH 3/6] Documentation: kernel-docs: Remove "Here is its" at the end of lines Jonathan Neuschäfer
@ 2017-05-15 13:40 ` Jonathan Neuschäfer
  2017-05-15 13:40 ` [PATCH 5/6] Documentation: howto: Remove outdated info about bugzilla mailing lists Jonathan Neuschäfer
  2017-05-15 13:40 ` [PATCH 6/6] Documentation: mono: Update links and s/CVS/Git/ Jonathan Neuschäfer
  4 siblings, 0 replies; 6+ messages in thread
From: Jonathan Neuschäfer @ 2017-05-15 13:40 UTC (permalink / raw)
  To: linux-doc; +Cc: linux-kernel, Jonathan Neuschäfer

Since the 3.2 cycle, there were no -git patches/tarballs on kernel.org.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/process/applying-patches.rst | 40 +-----------------------------
 Documentation/process/howto.rst            |  9 -------
 2 files changed, 1 insertion(+), 48 deletions(-)

diff --git a/Documentation/process/applying-patches.rst b/Documentation/process/applying-patches.rst
index a0d058cc6d25..eaf3e0296d6d 100644
--- a/Documentation/process/applying-patches.rst
+++ b/Documentation/process/applying-patches.rst
@@ -344,7 +344,7 @@ possible.
 
 This is a good branch to run for people who want to help out testing
 development kernels but do not want to run some of the really experimental
-stuff (such people should see the sections about -git and -mm kernels below).
+stuff (such people should see the sections about -mm kernels below).
 
 The -rc patches are not incremental, they apply to a base 4.x kernel, just
 like the 4.x.y patches described above. The kernel version before the -rcN
@@ -380,44 +380,6 @@ Here are 3 examples of how to apply these patches::
 	$ mv linux-4.7.3 linux-4.8-rc5		# rename the kernel source dir
 
 
-The -git kernels
-================
-
-These are daily snapshots of Linus' kernel tree (managed in a git
-repository, hence the name).
-
-These patches are usually released daily and represent the current state of
-Linus's tree. They are more experimental than -rc kernels since they are
-generated automatically without even a cursory glance to see if they are
-sane.
-
--git patches are not incremental and apply either to a base 4.x kernel or
-a base 4.x-rc kernel -- you can see which from their name.
-A patch named 4.7-git1 applies to the 4.7 kernel source and a patch
-named 4.8-rc3-git2 applies to the source of the 4.8-rc3 kernel.
-
-Here are some examples of how to apply these patches::
-
-	# moving from 4.7 to 4.7-git1
-
-	$ cd ~/linux-4.7			# change to the kernel source dir
-	$ patch -p1 < ../patch-4.7-git1		# apply the 4.7-git1 patch
-	$ cd ..
-	$ mv linux-4.7 linux-4.7-git1		# rename the kernel source dir
-
-	# moving from 4.7-git1 to 4.8-rc2-git3
-
-	$ cd ~/linux-4.7-git1			# change to the kernel source dir
-	$ patch -p1 -R < ../patch-4.7-git1	# revert the 4.7-git1 patch
-						# we now have a 4.7 kernel
-	$ patch -p1 < ../patch-4.8-rc2		# apply the 4.8-rc2 patch
-						# the kernel is now 4.8-rc2
-	$ patch -p1 < ../patch-4.8-rc2-git3	# apply the 4.8-rc2-git3 patch
-						# the kernel is now 4.8-rc2-git3
-	$ cd ..
-	$ mv linux-4.7-git1 linux-4.8-rc2-git3	# rename source dir
-
-
 The -mm patches and the linux-next tree
 =======================================
 
diff --git a/Documentation/process/howto.rst b/Documentation/process/howto.rst
index 1260f60d4cb9..340fa18ff341 100644
--- a/Documentation/process/howto.rst
+++ b/Documentation/process/howto.rst
@@ -314,15 +314,6 @@ The file Documentation/process/stable-kernel-rules.rst in the kernel tree
 documents what kinds of changes are acceptable for the -stable tree, and
 how the release process works.
 
-4.x -git patches
-~~~~~~~~~~~~~~~~
-
-These are daily snapshots of Linus' kernel tree which are managed in a
-git repository (hence the name.) These patches are usually released
-daily and represent the current state of Linus' tree.  They are more
-experimental than -rc kernels since they are generated automatically
-without even a cursory glance to see if they are sane.
-
 Subsystem Specific kernel trees and patches
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- 
2.11.0

^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH 5/6] Documentation: howto: Remove outdated info about bugzilla mailing lists
  2017-05-15 13:40 [PATCH 1/6] Documentation: coding-style: Escape \n\t to fix HTML rendering Jonathan Neuschäfer
                   ` (2 preceding siblings ...)
  2017-05-15 13:40 ` [PATCH 4/6] Documentation: Remove outdated info about -git patches Jonathan Neuschäfer
@ 2017-05-15 13:40 ` Jonathan Neuschäfer
  2017-05-15 13:40 ` [PATCH 6/6] Documentation: mono: Update links and s/CVS/Git/ Jonathan Neuschäfer
  4 siblings, 0 replies; 6+ messages in thread
From: Jonathan Neuschäfer @ 2017-05-15 13:40 UTC (permalink / raw)
  To: linux-doc; +Cc: linux-kernel, Jonathan Neuschäfer

The mailing list archives[1,2] show no activity since September 2011.

[1]: https://lists.linuxfoundation.org/pipermail/bugme-new/
[2]: https://lists.linuxfoundation.org/pipermail/bugme-janitors/

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/process/howto.rst | 8 --------
 1 file changed, 8 deletions(-)

diff --git a/Documentation/process/howto.rst b/Documentation/process/howto.rst
index 340fa18ff341..b696a51a832c 100644
--- a/Documentation/process/howto.rst
+++ b/Documentation/process/howto.rst
@@ -380,14 +380,6 @@ bugs is one of the best ways to get merits among other developers, because
 not many people like wasting time fixing other people's bugs.
 
 To work in the already reported bug reports, go to https://bugzilla.kernel.org.
-If you want to be advised of the future bug reports, you can subscribe to the
-bugme-new mailing list (only new bug reports are mailed here) or to the
-bugme-janitor mailing list (every change in the bugzilla is mailed here)
-
-	https://lists.linux-foundation.org/mailman/listinfo/bugme-new
-
-	https://lists.linux-foundation.org/mailman/listinfo/bugme-janitors
-
 
 
 Mailing lists
-- 
2.11.0

^ permalink raw reply related	[flat|nested] 6+ messages in thread

* [PATCH 6/6] Documentation: mono: Update links and s/CVS/Git/
  2017-05-15 13:40 [PATCH 1/6] Documentation: coding-style: Escape \n\t to fix HTML rendering Jonathan Neuschäfer
                   ` (3 preceding siblings ...)
  2017-05-15 13:40 ` [PATCH 5/6] Documentation: howto: Remove outdated info about bugzilla mailing lists Jonathan Neuschäfer
@ 2017-05-15 13:40 ` Jonathan Neuschäfer
  4 siblings, 0 replies; 6+ messages in thread
From: Jonathan Neuschäfer @ 2017-05-15 13:40 UTC (permalink / raw)
  To: linux-doc; +Cc: linux-kernel, Jonathan Neuschäfer

The old URLs redirect to the new ones, so just update them in mono.rst.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/admin-guide/mono.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/admin-guide/mono.rst b/Documentation/admin-guide/mono.rst
index cdddc099af64..77045ce548a0 100644
--- a/Documentation/admin-guide/mono.rst
+++ b/Documentation/admin-guide/mono.rst
@@ -9,14 +9,14 @@ This will allow you to execute Mono-based .NET binaries just like any
 other program after you have done the following:
 
 1) You MUST FIRST install the Mono CLR support, either by downloading
-   a binary package, a source tarball or by installing from CVS. Binary
+   a binary package, a source tarball or by installing from Git. Binary
    packages for several distributions can be found at:
 
-	http://go-mono.com/download.html
+	http://www.mono-project.com/download/
 
    Instructions for compiling Mono can be found at:
 
-	http://www.go-mono.com/compiling.html
+	http://www.mono-project.com/docs/compiling-mono/
 
    Once the Mono CLR support has been installed, just check that
    ``/usr/bin/mono`` (which could be located elsewhere, for example
-- 
2.11.0

^ permalink raw reply related	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2017-05-15 13:41 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2017-05-15 13:40 [PATCH 1/6] Documentation: coding-style: Escape \n\t to fix HTML rendering Jonathan Neuschäfer
2017-05-15 13:40 ` [PATCH 2/6] Documentation: kernel-docs: Move vfs.txt under "Docs at the Linux Kernel tree" Jonathan Neuschäfer
2017-05-15 13:40 ` [PATCH 3/6] Documentation: kernel-docs: Remove "Here is its" at the end of lines Jonathan Neuschäfer
2017-05-15 13:40 ` [PATCH 4/6] Documentation: Remove outdated info about -git patches Jonathan Neuschäfer
2017-05-15 13:40 ` [PATCH 5/6] Documentation: howto: Remove outdated info about bugzilla mailing lists Jonathan Neuschäfer
2017-05-15 13:40 ` [PATCH 6/6] Documentation: mono: Update links and s/CVS/Git/ Jonathan Neuschäfer

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).