* [PATCH] docs: fix some broken documentation references
@ 2018-09-17 19:02 Mauro Carvalho Chehab
2018-09-18 9:17 ` Jan Kara
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Mauro Carvalho Chehab @ 2018-09-17 19:02 UTC (permalink / raw)
To: linux-kernel
Cc: Mauro Carvalho Chehab, Linux Media Mailing List,
Mauro Carvalho Chehab, Jonathan Corbet, Jan Kara,
Stephen Hemminger, David S. Miller, Michael Ellerman,
Greg Kroah-Hartman, Andrew Morton, Arnd Bergmann, linux-doc,
linux-ext4, bridge, netdev
Some documentation files received recent changes and are
pointing to wrong places.
Those references can easily fixed with the help of a
script:
$ ./scripts/documentation-file-ref-check --fix
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
Documentation/filesystems/dax.txt | 2 +-
Documentation/filesystems/ext2.txt | 2 +-
MAINTAINERS | 4 ++--
net/bridge/Kconfig | 2 +-
4 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/Documentation/filesystems/dax.txt b/Documentation/filesystems/dax.txt
index 70cb68bed2e8..bc393e0a22b8 100644
--- a/Documentation/filesystems/dax.txt
+++ b/Documentation/filesystems/dax.txt
@@ -75,7 +75,7 @@ exposure of uninitialized data through mmap.
These filesystems may be used for inspiration:
- ext2: see Documentation/filesystems/ext2.txt
-- ext4: see Documentation/filesystems/ext4.txt
+- ext4: see Documentation/filesystems/ext4/ext4.rst
- xfs: see Documentation/filesystems/xfs.txt
diff --git a/Documentation/filesystems/ext2.txt b/Documentation/filesystems/ext2.txt
index 81c0becab225..a45c9fc0747b 100644
--- a/Documentation/filesystems/ext2.txt
+++ b/Documentation/filesystems/ext2.txt
@@ -358,7 +358,7 @@ and are copied into the filesystem. If a transaction is incomplete at
the time of the crash, then there is no guarantee of consistency for
the blocks in that transaction so they are discarded (which means any
filesystem changes they represent are also lost).
-Check Documentation/filesystems/ext4.txt if you want to read more about
+Check Documentation/filesystems/ext4/ext4.rst if you want to read more about
ext4 and journaling.
References
diff --git a/MAINTAINERS b/MAINTAINERS
index 9989925f658d..078a4cf6d064 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -840,7 +840,7 @@ ANALOG DEVICES INC ADGS1408 DRIVER
M: Mircea Caprioru <mircea.caprioru@analog.com>
S: Supported
F: drivers/mux/adgs1408.c
-F: Documentation/devicetree/bindings/mux/adgs1408.txt
+F: Documentation/devicetree/bindings/mux/adi,adgs1408.txt
ANALOG DEVICES INC ADP5061 DRIVER
M: Stefan Popa <stefan.popa@analog.com>
@@ -5515,7 +5515,7 @@ W: http://ext4.wiki.kernel.org
Q: http://patchwork.ozlabs.org/project/linux-ext4/list/
T: git git://git.kernel.org/pub/scm/linux/kernel/git/tytso/ext4.git
S: Maintained
-F: Documentation/filesystems/ext4.txt
+F: Documentation/filesystems/ext4/ext4.rst
F: fs/ext4/
Extended Verification Module (EVM)
diff --git a/net/bridge/Kconfig b/net/bridge/Kconfig
index aa0d3b2f1bb7..3625d6ade45c 100644
--- a/net/bridge/Kconfig
+++ b/net/bridge/Kconfig
@@ -17,7 +17,7 @@ config BRIDGE
other third party bridge products.
In order to use the Ethernet bridge, you'll need the bridge
- configuration tools; see <file:Documentation/networking/bridge.txt>
+ configuration tools; see <file:Documentation/networking/bridge.rst>
for location. Please read the Bridge mini-HOWTO for more
information.
--
2.17.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] docs: fix some broken documentation references
2018-09-17 19:02 [PATCH] docs: fix some broken documentation references Mauro Carvalho Chehab
@ 2018-09-18 9:17 ` Jan Kara
2018-09-18 14:39 ` Darrick J. Wong
2018-09-20 17:10 ` Jonathan Corbet
2 siblings, 0 replies; 4+ messages in thread
From: Jan Kara @ 2018-09-18 9:17 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: linux-kernel, Linux Media Mailing List, Mauro Carvalho Chehab,
Jonathan Corbet, Jan Kara, Stephen Hemminger, David S. Miller,
Michael Ellerman, Greg Kroah-Hartman, Andrew Morton,
Arnd Bergmann, linux-doc, linux-ext4, bridge, netdev, Ted Tso
On Mon 17-09-18 15:02:34, Mauro Carvalho Chehab wrote:
> Some documentation files received recent changes and are
> pointing to wrong places.
>
> Those references can easily fixed with the help of a
> script:
>
> $ ./scripts/documentation-file-ref-check --fix
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Looks good to me. Thanks for fixing this up. You can add:
Reviewed-by: Jan Kara <jack@suse.cz>
Honza
> ---
> Documentation/filesystems/dax.txt | 2 +-
> Documentation/filesystems/ext2.txt | 2 +-
> MAINTAINERS | 4 ++--
> net/bridge/Kconfig | 2 +-
> 4 files changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/filesystems/dax.txt b/Documentation/filesystems/dax.txt
> index 70cb68bed2e8..bc393e0a22b8 100644
> --- a/Documentation/filesystems/dax.txt
> +++ b/Documentation/filesystems/dax.txt
> @@ -75,7 +75,7 @@ exposure of uninitialized data through mmap.
>
> These filesystems may be used for inspiration:
> - ext2: see Documentation/filesystems/ext2.txt
> -- ext4: see Documentation/filesystems/ext4.txt
> +- ext4: see Documentation/filesystems/ext4/ext4.rst
> - xfs: see Documentation/filesystems/xfs.txt
>
>
> diff --git a/Documentation/filesystems/ext2.txt b/Documentation/filesystems/ext2.txt
> index 81c0becab225..a45c9fc0747b 100644
> --- a/Documentation/filesystems/ext2.txt
> +++ b/Documentation/filesystems/ext2.txt
> @@ -358,7 +358,7 @@ and are copied into the filesystem. If a transaction is incomplete at
> the time of the crash, then there is no guarantee of consistency for
> the blocks in that transaction so they are discarded (which means any
> filesystem changes they represent are also lost).
> -Check Documentation/filesystems/ext4.txt if you want to read more about
> +Check Documentation/filesystems/ext4/ext4.rst if you want to read more about
> ext4 and journaling.
>
> References
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 9989925f658d..078a4cf6d064 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -840,7 +840,7 @@ ANALOG DEVICES INC ADGS1408 DRIVER
> M: Mircea Caprioru <mircea.caprioru@analog.com>
> S: Supported
> F: drivers/mux/adgs1408.c
> -F: Documentation/devicetree/bindings/mux/adgs1408.txt
> +F: Documentation/devicetree/bindings/mux/adi,adgs1408.txt
>
> ANALOG DEVICES INC ADP5061 DRIVER
> M: Stefan Popa <stefan.popa@analog.com>
> @@ -5515,7 +5515,7 @@ W: http://ext4.wiki.kernel.org
> Q: http://patchwork.ozlabs.org/project/linux-ext4/list/
> T: git git://git.kernel.org/pub/scm/linux/kernel/git/tytso/ext4.git
> S: Maintained
> -F: Documentation/filesystems/ext4.txt
> +F: Documentation/filesystems/ext4/ext4.rst
> F: fs/ext4/
>
> Extended Verification Module (EVM)
> diff --git a/net/bridge/Kconfig b/net/bridge/Kconfig
> index aa0d3b2f1bb7..3625d6ade45c 100644
> --- a/net/bridge/Kconfig
> +++ b/net/bridge/Kconfig
> @@ -17,7 +17,7 @@ config BRIDGE
> other third party bridge products.
>
> In order to use the Ethernet bridge, you'll need the bridge
> - configuration tools; see <file:Documentation/networking/bridge.txt>
> + configuration tools; see <file:Documentation/networking/bridge.rst>
> for location. Please read the Bridge mini-HOWTO for more
> information.
>
> --
> 2.17.1
>
>
--
Jan Kara <jack@suse.com>
SUSE Labs, CR
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] docs: fix some broken documentation references
2018-09-17 19:02 [PATCH] docs: fix some broken documentation references Mauro Carvalho Chehab
2018-09-18 9:17 ` Jan Kara
@ 2018-09-18 14:39 ` Darrick J. Wong
2018-09-20 17:10 ` Jonathan Corbet
2 siblings, 0 replies; 4+ messages in thread
From: Darrick J. Wong @ 2018-09-18 14:39 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: linux-kernel, Linux Media Mailing List, Mauro Carvalho Chehab,
Jonathan Corbet, Jan Kara, Stephen Hemminger, David S. Miller,
Michael Ellerman, Greg Kroah-Hartman, Andrew Morton,
Arnd Bergmann, linux-doc, linux-ext4, bridge, netdev
On Mon, Sep 17, 2018 at 03:02:34PM -0400, Mauro Carvalho Chehab wrote:
> Some documentation files received recent changes and are
> pointing to wrong places.
>
> Those references can easily fixed with the help of a
> script:
>
> $ ./scripts/documentation-file-ref-check --fix
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Thanks for fixing up the ext4 parts!
Reviewed-by: Darrick J. Wong <darrick.wong@oracle.com>
--D
> ---
> Documentation/filesystems/dax.txt | 2 +-
> Documentation/filesystems/ext2.txt | 2 +-
> MAINTAINERS | 4 ++--
> net/bridge/Kconfig | 2 +-
> 4 files changed, 5 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/filesystems/dax.txt b/Documentation/filesystems/dax.txt
> index 70cb68bed2e8..bc393e0a22b8 100644
> --- a/Documentation/filesystems/dax.txt
> +++ b/Documentation/filesystems/dax.txt
> @@ -75,7 +75,7 @@ exposure of uninitialized data through mmap.
>
> These filesystems may be used for inspiration:
> - ext2: see Documentation/filesystems/ext2.txt
> -- ext4: see Documentation/filesystems/ext4.txt
> +- ext4: see Documentation/filesystems/ext4/ext4.rst
> - xfs: see Documentation/filesystems/xfs.txt
>
>
> diff --git a/Documentation/filesystems/ext2.txt b/Documentation/filesystems/ext2.txt
> index 81c0becab225..a45c9fc0747b 100644
> --- a/Documentation/filesystems/ext2.txt
> +++ b/Documentation/filesystems/ext2.txt
> @@ -358,7 +358,7 @@ and are copied into the filesystem. If a transaction is incomplete at
> the time of the crash, then there is no guarantee of consistency for
> the blocks in that transaction so they are discarded (which means any
> filesystem changes they represent are also lost).
> -Check Documentation/filesystems/ext4.txt if you want to read more about
> +Check Documentation/filesystems/ext4/ext4.rst if you want to read more about
> ext4 and journaling.
>
> References
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 9989925f658d..078a4cf6d064 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -840,7 +840,7 @@ ANALOG DEVICES INC ADGS1408 DRIVER
> M: Mircea Caprioru <mircea.caprioru@analog.com>
> S: Supported
> F: drivers/mux/adgs1408.c
> -F: Documentation/devicetree/bindings/mux/adgs1408.txt
> +F: Documentation/devicetree/bindings/mux/adi,adgs1408.txt
>
> ANALOG DEVICES INC ADP5061 DRIVER
> M: Stefan Popa <stefan.popa@analog.com>
> @@ -5515,7 +5515,7 @@ W: http://ext4.wiki.kernel.org
> Q: http://patchwork.ozlabs.org/project/linux-ext4/list/
> T: git git://git.kernel.org/pub/scm/linux/kernel/git/tytso/ext4.git
> S: Maintained
> -F: Documentation/filesystems/ext4.txt
> +F: Documentation/filesystems/ext4/ext4.rst
> F: fs/ext4/
>
> Extended Verification Module (EVM)
> diff --git a/net/bridge/Kconfig b/net/bridge/Kconfig
> index aa0d3b2f1bb7..3625d6ade45c 100644
> --- a/net/bridge/Kconfig
> +++ b/net/bridge/Kconfig
> @@ -17,7 +17,7 @@ config BRIDGE
> other third party bridge products.
>
> In order to use the Ethernet bridge, you'll need the bridge
> - configuration tools; see <file:Documentation/networking/bridge.txt>
> + configuration tools; see <file:Documentation/networking/bridge.rst>
> for location. Please read the Bridge mini-HOWTO for more
> information.
>
> --
> 2.17.1
>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] docs: fix some broken documentation references
2018-09-17 19:02 [PATCH] docs: fix some broken documentation references Mauro Carvalho Chehab
2018-09-18 9:17 ` Jan Kara
2018-09-18 14:39 ` Darrick J. Wong
@ 2018-09-20 17:10 ` Jonathan Corbet
2 siblings, 0 replies; 4+ messages in thread
From: Jonathan Corbet @ 2018-09-20 17:10 UTC (permalink / raw)
To: Mauro Carvalho Chehab
Cc: linux-kernel, Linux Media Mailing List, Mauro Carvalho Chehab,
Jan Kara, Stephen Hemminger, David S. Miller, Michael Ellerman,
Greg Kroah-Hartman, Andrew Morton, Arnd Bergmann, linux-doc,
linux-ext4, bridge, netdev
On Mon, 17 Sep 2018 15:02:34 -0400
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:
> Some documentation files received recent changes and are
> pointing to wrong places.
>
> Those references can easily fixed with the help of a
> script:
>
> $ ./scripts/documentation-file-ref-check --fix
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Applied, thanks.
jon
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2018-09-20 17:10 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-09-17 19:02 [PATCH] docs: fix some broken documentation references Mauro Carvalho Chehab
2018-09-18 9:17 ` Jan Kara
2018-09-18 14:39 ` Darrick J. Wong
2018-09-20 17:10 ` Jonathan Corbet
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).