[alsa-devel] [PATCH 0/6] ReST conversion patches not applied yet
Hi Jon,
As promised, this is the rebased version of the patches that were not applied from the /26 patch series because you had merge conflicts.
They're all based on your docs-next branch, so should apply fine.
The first one fixes all but one error with a broken reference.
The only broken reference right now is due to a DT patch with was not accepted (no idea why), but whose driver is upstream.
Mauro Carvalho Chehab (6): docs: fix a couple of new broken references docs: writing-schema.md: convert from markdown to ReST spi: docs: convert to ReST and add it to the kABI bookset docs: fs: cifs: convert to ReST and add to admin-guide book docs: fs: convert porting to ReST docs: w1: convert to ReST and add to the kAPI group of docs
Documentation/ABI/stable/sysfs-bus-w1 | 2 +- .../ABI/stable/sysfs-driver-w1_ds28e04 | 4 +- .../ABI/stable/sysfs-driver-w1_ds28ea00 | 2 +- .../AUTHORS => admin-guide/cifs/authors.rst} | 64 +- .../CHANGES => admin-guide/cifs/changes.rst} | 4 + Documentation/admin-guide/cifs/index.rst | 21 + .../cifs/introduction.rst} | 8 + .../cifs/TODO => admin-guide/cifs/todo.rst} | 87 +-- .../README => admin-guide/cifs/usage.rst} | 560 +++++++++++------- .../cifs/winucase_convert.pl | 0 Documentation/admin-guide/index.rst | 1 + .../bindings/sound/sun8i-a33-codec.txt | 2 +- Documentation/devicetree/writing-schema.md | 130 ---- Documentation/devicetree/writing-schema.rst | 153 +++++ Documentation/filesystems/porting.rst | 2 +- Documentation/index.rst | 2 + .../spi/{butterfly => butterfly.rst} | 44 +- Documentation/spi/index.rst | 22 + Documentation/spi/{pxa2xx => pxa2xx.rst} | 95 +-- .../spi/{spi-lm70llp => spi-lm70llp.rst} | 17 +- .../spi/{spi-sc18is602 => spi-sc18is602.rst} | 3 + .../spi/{spi-summary => spi-summary.rst} | 105 ++-- Documentation/spi/{spidev => spidev.rst} | 30 +- Documentation/w1/index.rst | 21 + .../w1/masters/{ds2482 => ds2482.rst} | 16 +- .../w1/masters/{ds2490 => ds2490.rst} | 6 +- Documentation/w1/masters/index.rst | 14 + Documentation/w1/masters/mxc-w1 | 12 - Documentation/w1/masters/mxc-w1.rst | 17 + .../w1/masters/{omap-hdq => omap-hdq.rst} | 12 +- .../w1/masters/{w1-gpio => w1-gpio.rst} | 21 +- Documentation/w1/slaves/index.rst | 16 + .../w1/slaves/{w1_ds2406 => w1_ds2406.rst} | 4 +- .../w1/slaves/{w1_ds2413 => w1_ds2413.rst} | 9 + Documentation/w1/slaves/w1_ds2423 | 47 -- Documentation/w1/slaves/w1_ds2423.rst | 54 ++ .../w1/slaves/{w1_ds2438 => w1_ds2438.rst} | 10 +- .../w1/slaves/{w1_ds28e04 => w1_ds28e04.rst} | 5 + .../w1/slaves/{w1_ds28e17 => w1_ds28e17.rst} | 16 +- .../w1/slaves/{w1_therm => w1_therm.rst} | 11 +- .../w1/{w1.generic => w1-generic.rst} | 88 +-- .../w1/{w1.netlink => w1-netlink.rst} | 89 +-- MAINTAINERS | 6 +- drivers/hwtracing/coresight/Kconfig | 2 +- drivers/iio/dummy/iio_simple_dummy.c | 2 +- drivers/spi/Kconfig | 2 +- drivers/spi/spi-butterfly.c | 2 +- drivers/spi/spi-lm70llp.c | 2 +- fs/jfs/Kconfig | 2 +- fs/ufs/Kconfig | 2 +- include/linux/platform_data/sc18is602.h | 2 +- 51 files changed, 1126 insertions(+), 722 deletions(-) rename Documentation/{filesystems/cifs/AUTHORS => admin-guide/cifs/authors.rst} (60%) rename Documentation/{filesystems/cifs/CHANGES => admin-guide/cifs/changes.rst} (91%) create mode 100644 Documentation/admin-guide/cifs/index.rst rename Documentation/{filesystems/cifs/cifs.txt => admin-guide/cifs/introduction.rst} (98%) rename Documentation/{filesystems/cifs/TODO => admin-guide/cifs/todo.rst} (58%) rename Documentation/{filesystems/cifs/README => admin-guide/cifs/usage.rst} (72%) rename Documentation/{filesystems => admin-guide}/cifs/winucase_convert.pl (100%) delete mode 100644 Documentation/devicetree/writing-schema.md create mode 100644 Documentation/devicetree/writing-schema.rst rename Documentation/spi/{butterfly => butterfly.rst} (71%) create mode 100644 Documentation/spi/index.rst rename Documentation/spi/{pxa2xx => pxa2xx.rst} (83%) rename Documentation/spi/{spi-lm70llp => spi-lm70llp.rst} (88%) rename Documentation/spi/{spi-sc18is602 => spi-sc18is602.rst} (97%) rename Documentation/spi/{spi-summary => spi-summary.rst} (93%) rename Documentation/spi/{spidev => spidev.rst} (90%) create mode 100644 Documentation/w1/index.rst rename Documentation/w1/masters/{ds2482 => ds2482.rst} (71%) rename Documentation/w1/masters/{ds2490 => ds2490.rst} (98%) create mode 100644 Documentation/w1/masters/index.rst delete mode 100644 Documentation/w1/masters/mxc-w1 create mode 100644 Documentation/w1/masters/mxc-w1.rst rename Documentation/w1/masters/{omap-hdq => omap-hdq.rst} (90%) rename Documentation/w1/masters/{w1-gpio => w1-gpio.rst} (75%) create mode 100644 Documentation/w1/slaves/index.rst rename Documentation/w1/slaves/{w1_ds2406 => w1_ds2406.rst} (96%) rename Documentation/w1/slaves/{w1_ds2413 => w1_ds2413.rst} (81%) delete mode 100644 Documentation/w1/slaves/w1_ds2423 create mode 100644 Documentation/w1/slaves/w1_ds2423.rst rename Documentation/w1/slaves/{w1_ds2438 => w1_ds2438.rst} (93%) rename Documentation/w1/slaves/{w1_ds28e04 => w1_ds28e04.rst} (93%) rename Documentation/w1/slaves/{w1_ds28e17 => w1_ds28e17.rst} (88%) rename Documentation/w1/slaves/{w1_therm => w1_therm.rst} (95%) rename Documentation/w1/{w1.generic => w1-generic.rst} (59%) rename Documentation/w1/{w1.netlink => w1-netlink.rst} (77%)
Those are due to recent changes. Most of the issues can be automatically fixed with:
$ ./scripts/documentation-file-ref-check --fix
The only exception was the sound binding with required manual work.
Signed-off-by: Mauro Carvalho Chehab mchehab+samsung@kernel.org --- Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt | 2 +- MAINTAINERS | 4 ++-- drivers/hwtracing/coresight/Kconfig | 2 +- fs/jfs/Kconfig | 2 +- fs/ufs/Kconfig | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt b/Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt index 2ca3d138528e..7ecf6bd60d27 100644 --- a/Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt +++ b/Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt @@ -4,7 +4,7 @@ Allwinner SUN8I audio codec On Sun8i-A33 SoCs, the audio is separated in different parts: - A DAI driver. It uses the "sun4i-i2s" driver which is documented here: - Documentation/devicetree/bindings/sound/sun4i-i2s.txt + Documentation/devicetree/bindings/sound/allwinner,sun4i-a10-i2s.yaml - An analog part of the codec which is handled as PRCM registers. See Documentation/devicetree/bindings/sound/sun8i-codec-analog.txt - An digital part of the codec which is documented in this current diff --git a/MAINTAINERS b/MAINTAINERS index 6de82f019a52..f109a8bcffda 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -8659,7 +8659,7 @@ L: jfs-discussion@lists.sourceforge.net W: http://jfs.sourceforge.net/ T: git git://github.com/kleikamp/linux-shaggy.git S: Maintained -F: Documentation/filesystems/jfs.txt +F: Documentation/admin-guide/jfs.rst F: fs/jfs/
JME NETWORK DRIVER @@ -16439,7 +16439,7 @@ F: drivers/hid/hid-udraw-ps3.c UFS FILESYSTEM M: Evgeniy Dushistov dushistov@mail.ru S: Maintained -F: Documentation/filesystems/ufs.txt +F: Documentation/admin-guide/ufs.rst F: fs/ufs/
UHID USERSPACE HID IO DRIVER: diff --git a/drivers/hwtracing/coresight/Kconfig b/drivers/hwtracing/coresight/Kconfig index 14638db4991d..7a9f5fb08330 100644 --- a/drivers/hwtracing/coresight/Kconfig +++ b/drivers/hwtracing/coresight/Kconfig @@ -106,7 +106,7 @@ config CORESIGHT_CPU_DEBUG can quickly get to know program counter (PC), secure state, exception level, etc. Before use debugging functionality, platform needs to ensure the clock domain and power domain are enabled - properly, please refer Documentation/trace/coresight-cpu-debug.txt + properly, please refer Documentation/trace/coresight-cpu-debug.rst for detailed description and the example for usage.
endif diff --git a/fs/jfs/Kconfig b/fs/jfs/Kconfig index 22a273bd4648..05cb0e8e4382 100644 --- a/fs/jfs/Kconfig +++ b/fs/jfs/Kconfig @@ -5,7 +5,7 @@ config JFS_FS select CRC32 help This is a port of IBM's Journaled Filesystem . More information is - available in the file file:Documentation/filesystems/jfs.txt. + available in the file file:Documentation/admin-guide/jfs.rst.
If you do not intend to use the JFS filesystem, say N.
diff --git a/fs/ufs/Kconfig b/fs/ufs/Kconfig index fcb41516ea59..6d30adb6b890 100644 --- a/fs/ufs/Kconfig +++ b/fs/ufs/Kconfig @@ -9,7 +9,7 @@ config UFS_FS this file system as well. Saying Y here will allow you to read from these partitions; if you also want to write to them, say Y to the experimental "UFS file system write support", below. Please read the - file file:Documentation/filesystems/ufs.txt for more information. + file file:Documentation/admin-guide/ufs.rst for more information.
The recently released UFS2 variant (used in FreeBSD 5.x) is READ-ONLY supported.
On Wed, Jul 31, 2019 at 2:08 PM Mauro Carvalho Chehab mchehab+samsung@kernel.org wrote:
Those are due to recent changes. Most of the issues can be automatically fixed with:
$ ./scripts/documentation-file-ref-check --fix
The only exception was the sound binding with required manual work.
Signed-off-by: Mauro Carvalho Chehab mchehab+samsung@kernel.org
Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt | 2 +-
Acked-by: Rob Herring robh@kernel.org
MAINTAINERS | 4 ++-- drivers/hwtracing/coresight/Kconfig | 2 +- fs/jfs/Kconfig | 2 +- fs/ufs/Kconfig | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-)
On 7/31/19 3:08 PM, Mauro Carvalho Chehab wrote:
Those are due to recent changes. Most of the issues can be automatically fixed with:
$ ./scripts/documentation-file-ref-check --fix
The only exception was the sound binding with required manual work.
Signed-off-by: Mauro Carvalho Chehab mchehab+samsung@kernel.org
Acked-by: > Dave Kleikamp dave.kleikamp@oracle.com
Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt | 2 +- MAINTAINERS | 4 ++-- drivers/hwtracing/coresight/Kconfig | 2 +- fs/jfs/Kconfig | 2 +- fs/ufs/Kconfig | 2 +- 5 files changed, 6 insertions(+), 6 deletions(-)
diff --git a/Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt b/Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt index 2ca3d138528e..7ecf6bd60d27 100644 --- a/Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt +++ b/Documentation/devicetree/bindings/sound/sun8i-a33-codec.txt @@ -4,7 +4,7 @@ Allwinner SUN8I audio codec On Sun8i-A33 SoCs, the audio is separated in different parts: - A DAI driver. It uses the "sun4i-i2s" driver which is documented here:
Documentation/devicetree/bindings/sound/sun4i-i2s.txt
Documentation/devicetree/bindings/sound/allwinner,sun4i-a10-i2s.yaml
See Documentation/devicetree/bindings/sound/sun8i-codec-analog.txt
- An analog part of the codec which is handled as PRCM registers.
- An digital part of the codec which is documented in this current
diff --git a/MAINTAINERS b/MAINTAINERS index 6de82f019a52..f109a8bcffda 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -8659,7 +8659,7 @@ L: jfs-discussion@lists.sourceforge.net W: http://jfs.sourceforge.net/ T: git git://github.com/kleikamp/linux-shaggy.git S: Maintained -F: Documentation/filesystems/jfs.txt +F: Documentation/admin-guide/jfs.rst F: fs/jfs/
JME NETWORK DRIVER @@ -16439,7 +16439,7 @@ F: drivers/hid/hid-udraw-ps3.c UFS FILESYSTEM M: Evgeniy Dushistov dushistov@mail.ru S: Maintained -F: Documentation/filesystems/ufs.txt +F: Documentation/admin-guide/ufs.rst F: fs/ufs/
UHID USERSPACE HID IO DRIVER: diff --git a/drivers/hwtracing/coresight/Kconfig b/drivers/hwtracing/coresight/Kconfig index 14638db4991d..7a9f5fb08330 100644 --- a/drivers/hwtracing/coresight/Kconfig +++ b/drivers/hwtracing/coresight/Kconfig @@ -106,7 +106,7 @@ config CORESIGHT_CPU_DEBUG can quickly get to know program counter (PC), secure state, exception level, etc. Before use debugging functionality, platform needs to ensure the clock domain and power domain are enabled
properly, please refer Documentation/trace/coresight-cpu-debug.txt
for detailed description and the example for usage.properly, please refer Documentation/trace/coresight-cpu-debug.rst
endif diff --git a/fs/jfs/Kconfig b/fs/jfs/Kconfig index 22a273bd4648..05cb0e8e4382 100644 --- a/fs/jfs/Kconfig +++ b/fs/jfs/Kconfig @@ -5,7 +5,7 @@ config JFS_FS select CRC32 help This is a port of IBM's Journaled Filesystem . More information is
available in the file <file:Documentation/filesystems/jfs.txt>.
available in the file <file:Documentation/admin-guide/jfs.rst>.
If you do not intend to use the JFS filesystem, say N.
diff --git a/fs/ufs/Kconfig b/fs/ufs/Kconfig index fcb41516ea59..6d30adb6b890 100644 --- a/fs/ufs/Kconfig +++ b/fs/ufs/Kconfig @@ -9,7 +9,7 @@ config UFS_FS this file system as well. Saying Y here will allow you to read from these partitions; if you also want to write to them, say Y to the experimental "UFS file system write support", below. Please read the
file <file:Documentation/filesystems/ufs.txt> for more information.
file <file:Documentation/admin-guide/ufs.rst> for more information. The recently released UFS2 variant (used in FreeBSD 5.x) is READ-ONLY supported.
On Wed, 31 Jul 2019 17:08:47 -0300 Mauro Carvalho Chehab mchehab+samsung@kernel.org wrote:
As promised, this is the rebased version of the patches that were not applied from the /26 patch series because you had merge conflicts.
They're all based on your docs-next branch, so should apply fine.
The first one fixes all but one error with a broken reference.
The only broken reference right now is due to a DT patch with was not accepted (no idea why), but whose driver is upstream.
All but 5/6 applied, thanks.
jon
On Wed, Jul 31, 2019 at 02:17:34PM -0600, Jonathan Corbet wrote:
Mauro Carvalho Chehab mchehab+samsung@kernel.org wrote:
As promised, this is the rebased version of the patches that were not applied from the /26 patch series because you had merge conflicts.
They're all based on your docs-next branch, so should apply fine.
The first one fixes all but one error with a broken reference.
The only broken reference right now is due to a DT patch with was not accepted (no idea why), but whose driver is upstream.
All but 5/6 applied, thanks.
Oh, I still hadn't reviewed this version of the SPI stuff :(
There were outstanding questions about where it was going to get moved to but if I read the diff correctly it looks like it didn't actually get moved in the end?
Em Wed, 31 Jul 2019 21:20:07 +0100 Mark Brown broonie@kernel.org escreveu:
On Wed, Jul 31, 2019 at 02:17:34PM -0600, Jonathan Corbet wrote:
Mauro Carvalho Chehab mchehab+samsung@kernel.org wrote:
As promised, this is the rebased version of the patches that were not applied from the /26 patch series because you had merge conflicts.
They're all based on your docs-next branch, so should apply fine.
The first one fixes all but one error with a broken reference.
The only broken reference right now is due to a DT patch with was not accepted (no idea why), but whose driver is upstream.
All but 5/6 applied, thanks.
Oh, I still hadn't reviewed this version of the SPI stuff :(
It is basically the one sent on that /26 patch series, just rebased on the top of docs-next.
There were outstanding questions about where it was going to get moved to but if I read the diff correctly it looks like it didn't actually get moved in the end?
Yeah, it doesn't have the move. My understanding from our discussions is that we didn't reach a conclusion.
In any case, I can send a separate patch with the move part once we reach an agreement about what's the best way to proceed (or you can do it directly, if you prefer so).
Thanks, Mauro
On Wed, Jul 31, 2019 at 05:26:13PM -0300, Mauro Carvalho Chehab wrote:
Mark Brown broonie@kernel.org escreveu:
There were outstanding questions about where it was going to get moved to but if I read the diff correctly it looks like it didn't actually get moved in the end?
Yeah, it doesn't have the move. My understanding from our discussions is that we didn't reach a conclusion.
Yes, that was my understanding too which was why I was surprised to see this going in. This is OK then, I'd have acked it.
In any case, I can send a separate patch with the move part once we reach an agreement about what's the best way to proceed (or you can do it directly, if you prefer so).
I'm not likely to do anything without someone sending patches, I'm not clear on the utility of the move with the current division of the manuals. I don't know if it makes sense to have an embedded developer's manual as well?
Em Wed, 31 Jul 2019 21:37:12 +0100 Mark Brown broonie@kernel.org escreveu:
On Wed, Jul 31, 2019 at 05:26:13PM -0300, Mauro Carvalho Chehab wrote:
Mark Brown broonie@kernel.org escreveu:
There were outstanding questions about where it was going to get moved to but if I read the diff correctly it looks like it didn't actually get moved in the end?
Yeah, it doesn't have the move. My understanding from our discussions is that we didn't reach a conclusion.
Yes, that was my understanding too which was why I was surprised to see this going in. This is OK then, I'd have acked it.
In any case, I can send a separate patch with the move part once we reach an agreement about what's the best way to proceed (or you can do it directly, if you prefer so).
I'm not likely to do anything without someone sending patches, I'm not clear on the utility of the move with the current division of the manuals.
Same here: I do see value on having docs focused on their audience.
Yet, I'm not so sure how worth is to break some subsystem documentation into books, as, on some cases, this would mean huge efforts.
I'd prefer to see the big picture first, finishing the conversion and then looking at the resulting docs.
Meanwhile, if someone needs something that it is at the wrong book, he can just use some search tool to seek what he needs, no matter on what book the relevant information is stored.
I don't know if it makes sense to have an embedded developer's manual as well?
Yeah, that's a good question.
Jon is planning todo a documentation track at LPC. One of the things that should be discussed, IMO, is how we'll organize the books.
I suspect that, once we finish the conversion of the remaining ~300 files to ReST, the next logical step is to check what are the gaps and have a list of pending tasks.
Thanks, Mauro
On Wed, Jul 31, 2019 at 06:27:29PM -0300, Mauro Carvalho Chehab wrote:
Meanwhile, if someone needs something that it is at the wrong book, he can just use some search tool to seek what he needs, no matter on what book the relevant information is stored.
OTOH it might be weird for the intended audience of the book.
Mark Brown broonie@kernel.org escreveu:
I don't know if it makes sense to have an embedded developer's manual as well?
Yeah, that's a good question.
Jon is planning todo a documentation track at LPC. One of the things that should be discussed, IMO, is how we'll organize the books.
I'll be at Plumbers, not sure what the schedule's looking like yet though.
participants (5)
-
Dave Kleikamp
-
Jonathan Corbet
-
Mark Brown
-
Mauro Carvalho Chehab
-
Rob Herring