Documentation: fix little inconsistencies

Message ID 20170828094638.GA15378@amd
State New
Headers show
Series
  • Documentation: fix little inconsistencies
Related show

Commit Message

Pavel Machek Aug. 28, 2017, 9:46 a.m.
Fix little inconsistencies in Documentation: make case and spacing
match surrounding text, fix ascii-art.

Signed-off-by: Pavel Machek <pavel@ucw.cz>

Comments

Darrick J. Wong Aug. 28, 2017, 4:17 p.m. | #1
On Mon, Aug 28, 2017 at 11:46:39AM +0200, Pavel Machek wrote:
> Fix little inconsistencies in Documentation: make case and spacing
> match surrounding text, fix ascii-art.
> 
> Signed-off-by: Pavel Machek <pavel@ucw.cz>
> 
> diff --git a/Documentation/filesystems/ext4.txt b/Documentation/filesystems/ext4.txt
> index 5a8f7f4..75236c0 100644
> --- a/Documentation/filesystems/ext4.txt
> +++ b/Documentation/filesystems/ext4.txt
> @@ -94,10 +94,10 @@ Note: More extensive information for getting started with ext4 can be
>  * ability to pack bitmaps and inode tables into larger virtual groups via the
>    flex_bg feature
>  * large file support
> -* Inode allocation using large virtual block groups via flex_bg
> +* inode allocation using large virtual block groups via flex_bg
>  * delayed allocation
>  * large block (up to pagesize) support
> -* efficient new ordered mode in JBD2 and ext4(avoid using buffer head to force
> +* efficient new ordered mode in JBD2 and ext4 (avoid using buffer head to force
>    the ordering)
>  
>  [1] Filesystems with a block size of 1k may see a limit imposed by the
> @@ -105,7 +105,7 @@ directory hash tree having a maximum depth of two.
>  
>  2.2 Candidate features for future inclusion
>  
> -* Online defrag (patches available but not well tested)
> +* online defrag (patches available but not well tested)
>  * reduced mke2fs time via lazy itable initialization in conjunction with
>    the uninit_bg feature (capability to do this is available in e2fsprogs
>    but a kernel thread to do lazy zeroing of unused inode table blocks
> @@ -602,7 +602,7 @@ Table of Ext4 specific ioctls
>  			      bitmaps and inode table, the userspace tool thus
>  			      just passes the new number of blocks.
>  
> -EXT4_IOC_SWAP_BOOT	      Swap i_blocks and associated attributes
> + EXT4_IOC_SWAP_BOOT	      Swap i_blocks and associated attributes
>  			      (like i_blocks, i_size, i_flags, ...) from
>  			      the specified inode with inode
>  			      EXT4_BOOT_LOADER_INO (#5). This is typically
> diff --git a/Documentation/networking/switchdev.txt b/Documentation/networking/switchdev.txt
> index 5e40e1f..6309e90 100644
> --- a/Documentation/networking/switchdev.txt
> +++ b/Documentation/networking/switchdev.txt
> @@ -29,7 +29,7 @@ with SR-IOV or soft switches, such as OVS, are possible.
>                        sw1p1  +  sw1p3  +  sw1p5  +          eth1
>                          +    |    +    |    +    |            +
>                          |    |    |    |    |    |            |
> -                     +--+----+----+----+-+--+----+---+  +-----+-----+
> +                     +--+----+----+----+----+----+---+  +-----+-----+

Except for this last part, looks ok.

Reviewed-by: Darrick J. Wong <darrick.wong@oracle.com>

--D

>                       |         Switch driver         |  |    mgmt   |
>                       |        (this document)        |  |   driver  |
>                       |                               |  |           |
> 
> -- 
> (english) http://www.livejournal.com/~pavelmachek
> (cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
Pavel Machek Aug. 29, 2017, 7:27 a.m. | #2
> > index 5e40e1f..6309e90 100644
> > --- a/Documentation/networking/switchdev.txt
> > +++ b/Documentation/networking/switchdev.txt
> > @@ -29,7 +29,7 @@ with SR-IOV or soft switches, such as OVS, are possible.
> >                        sw1p1  +  sw1p3  +  sw1p5  +          eth1
> >                          +    |    +    |    +    |            +
> >                          |    |    |    |    |    |            |
> > -                     +--+----+----+----+-+--+----+---+  +-----+-----+
> > +                     +--+----+----+----+----+----+---+  +-----+-----+
> 
> Except for this last part, looks ok.

Anything wrong here? It is fixing extra '+' in the ascii art...
									Pavel

> Reviewed-by: Darrick J. Wong <darrick.wong@oracle.com>
> 
> --D
> 
> >                       |         Switch driver         |  |    mgmt   |
> >                       |        (this document)        |  |   driver  |
> >                       |                               |  |           |
> > 
> > -- 
> > (english) http://www.livejournal.com/~pavelmachek
> > (cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
>
Darrick J. Wong Aug. 29, 2017, 4:50 p.m. | #3
On Tue, Aug 29, 2017 at 09:27:08AM +0200, Pavel Machek wrote:
> 
> 
> > > index 5e40e1f..6309e90 100644
> > > --- a/Documentation/networking/switchdev.txt
> > > +++ b/Documentation/networking/switchdev.txt
> > > @@ -29,7 +29,7 @@ with SR-IOV or soft switches, such as OVS, are possible.
> > >                        sw1p1  +  sw1p3  +  sw1p5  +          eth1
> > >                          +    |    +    |    +    |            +
> > >                          |    |    |    |    |    |            |
> > > -                     +--+----+----+----+-+--+----+---+  +-----+-----+
> > > +                     +--+----+----+----+----+----+---+  +-----+-----+
> > 
> > Except for this last part, looks ok.
> 
> Anything wrong here? It is fixing extra '+' in the ascii art...

There's nothing incorrect here, I merely thought it odd to send a fix
for networking documentation to the ext4 list, but not netdev?

--D

> 									Pavel
> 
> > Reviewed-by: Darrick J. Wong <darrick.wong@oracle.com>
> > 
> > --D
> > 
> > >                       |         Switch driver         |  |    mgmt   |
> > >                       |        (this document)        |  |   driver  |
> > >                       |                               |  |           |
> > > 
> > > -- 
> > > (english) http://www.livejournal.com/~pavelmachek
> > > (cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
> > 
> 
> -- 
> (english) http://www.livejournal.com/~pavelmachek
> (cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html
Jonathan Corbet Aug. 29, 2017, 7:09 p.m. | #4
On Tue, 29 Aug 2017 09:50:57 -0700
"Darrick J. Wong" <darrick.wong@oracle.com> wrote:

> > Anything wrong here? It is fixing extra '+' in the ascii art...  
> 
> There's nothing incorrect here, I merely thought it odd to send a fix
> for networking documentation to the ext4 list, but not netdev?

In fact, davem likes to handle networking documentation patches himself,
so resending this one to netdev would be a good idea.

Thanks,

jon
Pavel Machek Aug. 29, 2017, 8:34 p.m. | #5
On Tue 2017-08-29 13:09:45, Jonathan Corbet wrote:
> On Tue, 29 Aug 2017 09:50:57 -0700
> "Darrick J. Wong" <darrick.wong@oracle.com> wrote:
> 
> > > Anything wrong here? It is fixing extra '+' in the ascii art...  
> > 
> > There's nothing incorrect here, I merely thought it odd to send a fix
> > for networking documentation to the ext4 list, but not netdev?
> 
> In fact, davem likes to handle networking documentation patches himself,
> so resending this one to netdev would be a good idea.

Its a typo in documentation, do we really need to waste any more time
with it? Dave, can you just ack it?

> > index 5e40e1f..6309e90 100644
> > --- a/Documentation/networking/switchdev.txt
> > +++ b/Documentation/networking/switchdev.txt
> > @@ -29,7 +29,7 @@ with SR-IOV or soft switches, such as OVS, are
> > possible.
> >                        sw1p1  +  sw1p3  +  sw1p5  +          eth1
> >                          +    |    +    |    +    |            +
> >                          |    |    |    |    |    |            |
> > -                     +--+----+----+----+-+--+----+---+  +-----+-----+
> > +                     +--+----+----+----+----+----+---+  +-----+-----+

Besides, if documentation fixes should go to Davem/netdev,
getmaintainer.pl should say so:

pavel@duo:/data/l/linux-n900$ scripts/get_maintainer.pl -f
Documentation/networking
Jonathan Corbet <corbet@lwn.net> (maintainer:DOCUMENTATION)
"David S. Miller" <davem@davemloft.net> (commit_signer:52/87=60%)
David Howells <dhowells@redhat.com>
(commit_signer:7/87=8%,authored:8/87=9%)
Florian Fainelli <f.fainelli@gmail.com> (commit_signer:6/87=7%)
Mauro Carvalho Chehab <mchehab@kernel.org>
(commit_signer:6/87=7%,authored:5/87=6%)
Yuchung Cheng <ycheng@google.com> (commit_signer:6/87=7%)
Hangbin Liu <liuhangbin@gmail.com> (authored:5/87=6%)
linux-doc@vger.kernel.org (open list:DOCUMENTATION)
linux-kernel@vger.kernel.org (open list)
pavel@duo:/data/l/linux-n900$

									
									Pavel

Patch

diff --git a/Documentation/filesystems/ext4.txt b/Documentation/filesystems/ext4.txt
index 5a8f7f4..75236c0 100644
--- a/Documentation/filesystems/ext4.txt
+++ b/Documentation/filesystems/ext4.txt
@@ -94,10 +94,10 @@  Note: More extensive information for getting started with ext4 can be
 * ability to pack bitmaps and inode tables into larger virtual groups via the
   flex_bg feature
 * large file support
-* Inode allocation using large virtual block groups via flex_bg
+* inode allocation using large virtual block groups via flex_bg
 * delayed allocation
 * large block (up to pagesize) support
-* efficient new ordered mode in JBD2 and ext4(avoid using buffer head to force
+* efficient new ordered mode in JBD2 and ext4 (avoid using buffer head to force
   the ordering)
 
 [1] Filesystems with a block size of 1k may see a limit imposed by the
@@ -105,7 +105,7 @@  directory hash tree having a maximum depth of two.
 
 2.2 Candidate features for future inclusion
 
-* Online defrag (patches available but not well tested)
+* online defrag (patches available but not well tested)
 * reduced mke2fs time via lazy itable initialization in conjunction with
   the uninit_bg feature (capability to do this is available in e2fsprogs
   but a kernel thread to do lazy zeroing of unused inode table blocks
@@ -602,7 +602,7 @@  Table of Ext4 specific ioctls
 			      bitmaps and inode table, the userspace tool thus
 			      just passes the new number of blocks.
 
-EXT4_IOC_SWAP_BOOT	      Swap i_blocks and associated attributes
+ EXT4_IOC_SWAP_BOOT	      Swap i_blocks and associated attributes
 			      (like i_blocks, i_size, i_flags, ...) from
 			      the specified inode with inode
 			      EXT4_BOOT_LOADER_INO (#5). This is typically
diff --git a/Documentation/networking/switchdev.txt b/Documentation/networking/switchdev.txt
index 5e40e1f..6309e90 100644
--- a/Documentation/networking/switchdev.txt
+++ b/Documentation/networking/switchdev.txt
@@ -29,7 +29,7 @@  with SR-IOV or soft switches, such as OVS, are possible.
                       sw1p1  +  sw1p3  +  sw1p5  +          eth1
                         +    |    +    |    +    |            +
                         |    |    |    |    |    |            |
-                     +--+----+----+----+-+--+----+---+  +-----+-----+
+                     +--+----+----+----+----+----+---+  +-----+-----+
                      |         Switch driver         |  |    mgmt   |
                      |        (this document)        |  |   driver  |
                      |                               |  |           |