diff mbox series

[43/44] docs: filesystems: convert udf.txt to ReST

Message ID 2887f8a3a813a31170389eab687e9f199327dc7d.1581955849.git.mchehab+huawei@kernel.org (mailing list archive)
State New, archived
Headers show
Series [01/44] docs: filesystems: convert 9p.txt to ReST | expand

Commit Message

Mauro Carvalho Chehab Feb. 17, 2020, 4:12 p.m. UTC
- Add a SPDX header;
- Add a document title;
- Add table markups;
- Add lists markups;
- Add it to filesystems/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/filesystems/index.rst           |  1 +
 .../filesystems/{udf.txt => udf.rst}          | 21 +++++++++++++------
 2 files changed, 16 insertions(+), 6 deletions(-)
 rename Documentation/filesystems/{udf.txt => udf.rst} (83%)

Comments

Jan Kara Feb. 18, 2020, 7:12 a.m. UTC | #1
On Mon 17-02-20 17:12:29, Mauro Carvalho Chehab wrote:
> - Add a SPDX header;
> - Add a document title;
> - Add table markups;
> - Add lists markups;
> - Add it to filesystems/index.rst.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Thanks! You can add:

Acked-by: Jan Kara <jack@suse.cz>

and I can pickup the patch if you want.

								Honza

> ---
>  Documentation/filesystems/index.rst           |  1 +
>  .../filesystems/{udf.txt => udf.rst}          | 21 +++++++++++++------
>  2 files changed, 16 insertions(+), 6 deletions(-)
>  rename Documentation/filesystems/{udf.txt => udf.rst} (83%)
> 
> diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
> index 58d57c9bf922..ec03cb4d7353 100644
> --- a/Documentation/filesystems/index.rst
> +++ b/Documentation/filesystems/index.rst
> @@ -92,5 +92,6 @@ Documentation for filesystem implementations.
>     tmpfs
>     ubifs
>     ubifs-authentication.rst
> +   udf
>     virtiofs
>     vfat
> diff --git a/Documentation/filesystems/udf.txt b/Documentation/filesystems/udf.rst
> similarity index 83%
> rename from Documentation/filesystems/udf.txt
> rename to Documentation/filesystems/udf.rst
> index e2f2faf32f18..d9badbf285b2 100644
> --- a/Documentation/filesystems/udf.txt
> +++ b/Documentation/filesystems/udf.rst
> @@ -1,6 +1,8 @@
> -*
> -* Documentation/filesystems/udf.txt
> -*
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +===============
> +UDF file system
> +===============
>  
>  If you encounter problems with reading UDF discs using this driver,
>  please report them according to MAINTAINERS file.
> @@ -18,8 +20,10 @@ performance due to very poor read-modify-write support supplied internally
>  by drive firmware.
>  
>  -------------------------------------------------------------------------------
> +
>  The following mount options are supported:
>  
> +	===========	======================================
>  	gid=		Set the default group.
>  	umask=		Set the default umask.
>  	mode=		Set the default file permissions.
> @@ -34,6 +38,7 @@ The following mount options are supported:
>  	longad		Use long ad's (default)
>  	nostrict	Unset strict conformance
>  	iocharset=	Set the NLS character set
> +	===========	======================================
>  
>  The uid= and gid= options need a bit more explaining.  They will accept a
>  decimal numeric value and all inodes on that mount will then appear as
> @@ -47,13 +52,17 @@ the interactive user will always see the files on the disk as belonging to him.
>  
>  The remaining are for debugging and disaster recovery:
>  
> -	novrs		Skip volume sequence recognition 
> +	=====		================================
> +	novrs		Skip volume sequence recognition
> +	=====		================================
>  
>  The following expect a offset from 0.
>  
> +	==========	=================================================
>  	session=	Set the CDROM session (default= last session)
>  	anchor=		Override standard anchor location. (default= 256)
>  	lastblock=	Set the last block of the filesystem/
> +	==========	=================================================
>  
>  -------------------------------------------------------------------------------
>  
> @@ -62,5 +71,5 @@ For the latest version and toolset see:
>  	https://github.com/pali/udftools
>  
>  Documentation on UDF and ECMA 167 is available FREE from:
> -	http://www.osta.org/
> -	http://www.ecma-international.org/
> +	- http://www.osta.org/
> +	- http://www.ecma-international.org/
> -- 
> 2.24.1
>
Mauro Carvalho Chehab Feb. 18, 2020, 10:13 a.m. UTC | #2
Em Tue, 18 Feb 2020 08:12:05 +0100
Jan Kara <jack@suse.cz> escreveu:

> On Mon 17-02-20 17:12:29, Mauro Carvalho Chehab wrote:
> > - Add a SPDX header;
> > - Add a document title;
> > - Add table markups;
> > - Add lists markups;
> > - Add it to filesystems/index.rst.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>  
> 
> Thanks! You can add:
> 
> Acked-by: Jan Kara <jack@suse.cz>

Thanks for reviewing it!
 
> and I can pickup the patch if you want.

From my side, it would be ok if you want to pick any patches from this series.

Still, as they all touch Documentation/filesystems/index.rst, in order
to avoid (trivial) conflicts, IMO the best would be to have all of them
applied at the same tree (either a FS tree or the docs tree).

Cheers,
Mauro
Jan Kara Feb. 18, 2020, 10:57 a.m. UTC | #3
On Tue 18-02-20 11:13:23, Mauro Carvalho Chehab wrote:
> Em Tue, 18 Feb 2020 08:12:05 +0100
> Jan Kara <jack@suse.cz> escreveu:
> 
> > On Mon 17-02-20 17:12:29, Mauro Carvalho Chehab wrote:
> > > - Add a SPDX header;
> > > - Add a document title;
> > > - Add table markups;
> > > - Add lists markups;
> > > - Add it to filesystems/index.rst.
> > > 
> > > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>  
> > 
> > Thanks! You can add:
> > 
> > Acked-by: Jan Kara <jack@suse.cz>
> 
> Thanks for reviewing it!
>  
> > and I can pickup the patch if you want.
> 
> From my side, it would be ok if you want to pick any patches from this series.
> 
> Still, as they all touch Documentation/filesystems/index.rst, in order
> to avoid (trivial) conflicts, IMO the best would be to have all of them
> applied at the same tree (either a FS tree or the docs tree).

Yeah, I also think it makes more sense to just push them through a single
tree - likely docs tree...

								Honza
diff mbox series

Patch

diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
index 58d57c9bf922..ec03cb4d7353 100644
--- a/Documentation/filesystems/index.rst
+++ b/Documentation/filesystems/index.rst
@@ -92,5 +92,6 @@  Documentation for filesystem implementations.
    tmpfs
    ubifs
    ubifs-authentication.rst
+   udf
    virtiofs
    vfat
diff --git a/Documentation/filesystems/udf.txt b/Documentation/filesystems/udf.rst
similarity index 83%
rename from Documentation/filesystems/udf.txt
rename to Documentation/filesystems/udf.rst
index e2f2faf32f18..d9badbf285b2 100644
--- a/Documentation/filesystems/udf.txt
+++ b/Documentation/filesystems/udf.rst
@@ -1,6 +1,8 @@ 
-*
-* Documentation/filesystems/udf.txt
-*
+.. SPDX-License-Identifier: GPL-2.0
+
+===============
+UDF file system
+===============
 
 If you encounter problems with reading UDF discs using this driver,
 please report them according to MAINTAINERS file.
@@ -18,8 +20,10 @@  performance due to very poor read-modify-write support supplied internally
 by drive firmware.
 
 -------------------------------------------------------------------------------
+
 The following mount options are supported:
 
+	===========	======================================
 	gid=		Set the default group.
 	umask=		Set the default umask.
 	mode=		Set the default file permissions.
@@ -34,6 +38,7 @@  The following mount options are supported:
 	longad		Use long ad's (default)
 	nostrict	Unset strict conformance
 	iocharset=	Set the NLS character set
+	===========	======================================
 
 The uid= and gid= options need a bit more explaining.  They will accept a
 decimal numeric value and all inodes on that mount will then appear as
@@ -47,13 +52,17 @@  the interactive user will always see the files on the disk as belonging to him.
 
 The remaining are for debugging and disaster recovery:
 
-	novrs		Skip volume sequence recognition 
+	=====		================================
+	novrs		Skip volume sequence recognition
+	=====		================================
 
 The following expect a offset from 0.
 
+	==========	=================================================
 	session=	Set the CDROM session (default= last session)
 	anchor=		Override standard anchor location. (default= 256)
 	lastblock=	Set the last block of the filesystem/
+	==========	=================================================
 
 -------------------------------------------------------------------------------
 
@@ -62,5 +71,5 @@  For the latest version and toolset see:
 	https://github.com/pali/udftools
 
 Documentation on UDF and ECMA 167 is available FREE from:
-	http://www.osta.org/
-	http://www.ecma-international.org/
+	- http://www.osta.org/
+	- http://www.ecma-international.org/