diff mbox series

[v2,01/26] docs: power: add it to to the main documentation index

Message ID 5417112ea7a391e6622c46bf833b7d6a5725c158.1564145354.git.mchehab+samsung@kernel.org (mailing list archive)
State Not Applicable, archived
Headers show
Series ReST conversion of text files without .txt extension | expand

Commit Message

Mauro Carvalho Chehab July 26, 2019, 12:51 p.m. UTC
The power docs are orphaned at the documentation body.

While it could likely be moved to be inside some guide, I'm opting to just
adding it to the main index.rst, removing the :orphan: and adding the SPDX
header.

The reason is similar to what it was done for other driver-specific
subsystems: the docs there contain a mix of Kernelspace, uAPI and
admin-guide. So, better to keep them on its own directory,
while the docs there are not properly classified.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
---
 Documentation/index.rst       | 1 +
 Documentation/power/index.rst | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

Comments

Jonathan Corbet July 31, 2019, 7:03 p.m. UTC | #1
On Fri, 26 Jul 2019 09:51:11 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:

> The power docs are orphaned at the documentation body.
> 
> While it could likely be moved to be inside some guide, I'm opting to just
> adding it to the main index.rst, removing the :orphan: and adding the SPDX
> header.
> 
> The reason is similar to what it was done for other driver-specific
> subsystems: the docs there contain a mix of Kernelspace, uAPI and
> admin-guide. So, better to keep them on its own directory,
> while the docs there are not properly classified.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>

So this one went upstream with the PDF fixes pull, right?  I'm a little
surprised to see it here now.

Thanks,

jon
Mauro Carvalho Chehab July 31, 2019, 7:16 p.m. UTC | #2
Em Wed, 31 Jul 2019 13:03:38 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Fri, 26 Jul 2019 09:51:11 -0300
> Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:
> 
> > The power docs are orphaned at the documentation body.
> > 
> > While it could likely be moved to be inside some guide, I'm opting to just
> > adding it to the main index.rst, removing the :orphan: and adding the SPDX
> > header.
> > 
> > The reason is similar to what it was done for other driver-specific
> > subsystems: the docs there contain a mix of Kernelspace, uAPI and
> > admin-guide. So, better to keep them on its own directory,
> > while the docs there are not properly classified.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>  
> 
> So this one went upstream with the PDF fixes pull, right?  I'm a little
> surprised to see it here now.

Yeah, this specific patch went together with the PDF fixes. 

The remaining ones in this series aren't there yet.

From this series, besides this patch, you can also exclude patch
25/26, as it seems that Paul will merge via RCU tree.

The remaining ones apply cleanly on the top of docs-next
(I tested applying them on the top of your tree yesterday).

Thanks,
Mauro
Jonathan Corbet July 31, 2019, 7:34 p.m. UTC | #3
On Wed, 31 Jul 2019 16:16:06 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:

> The remaining ones in this series aren't there yet.
> 
> From this series, besides this patch, you can also exclude patch
> 25/26, as it seems that Paul will merge via RCU tree.
> 
> The remaining ones apply cleanly on the top of docs-next
> (I tested applying them on the top of your tree yesterday).

Hmm...really?

- [PATCH v2 03/26] docs: powerpc: convert docs to ReST and rename to *.rst

	Seems to already be applied.

- [PATCH v2 07/26] docs: w1: convert to ReST and add to the kAPI group of
  docs

	Gives me the dreaded "could not build fake ancestor" error, I
	don't really understand why.

- [PATCH v2 08/26] spi: docs: convert to ReST and add it to the kABI
  bookset
- [PATCH v2 16/26] docs: fs: cifs: convert to ReST and add to admin-guide
  book

	Likewise

I've applied the others, so we're getting closer...

jon
Mauro Carvalho Chehab July 31, 2019, 7:58 p.m. UTC | #4
Em Wed, 31 Jul 2019 13:34:43 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Wed, 31 Jul 2019 16:16:06 -0300
> Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:
> 
> > The remaining ones in this series aren't there yet.
> > 
> > From this series, besides this patch, you can also exclude patch
> > 25/26, as it seems that Paul will merge via RCU tree.
> > 
> > The remaining ones apply cleanly on the top of docs-next
> > (I tested applying them on the top of your tree yesterday).  
> 
> Hmm...really?
> 
> - [PATCH v2 03/26] docs: powerpc: convert docs to ReST and rename to *.rst
> 
> 	Seems to already be applied.
> 
> - [PATCH v2 07/26] docs: w1: convert to ReST and add to the kAPI group of
>   docs
> 
> 	Gives me the dreaded "could not build fake ancestor" error, I
> 	don't really understand why.

That's new! What Sphinx version are you using?

Btw, on my build here (Sphinx 2.0.1 on Python3), I can't see this error.

> 
> - [PATCH v2 08/26] spi: docs: convert to ReST and add it to the kABI
>   bookset
> - [PATCH v2 16/26] docs: fs: cifs: convert to ReST and add to admin-guide
>   book
> 
> 	Likewise
> 
> I've applied the others, so we're getting closer...

Weird...

I did a rebase here on the top of your current docs/docs-next... they
apply fine. Had to do just a small trivial fix on one of the patches.

Anyway, thanks for merging those... I have now just 5 patches.

Btw, it seems that there are now 5 new broken links:

MAINTAINERS: Documentation/filesystems/jfs.txt
MAINTAINERS: Documentation/filesystems/ufs.txt
drivers/hwtracing/coresight/Kconfig: Documentation/trace/coresight-cpu-debug.txt
fs/jfs/Kconfig: file:Documentation/filesystems/jfs.txt
fs/ufs/Kconfig: file:Documentation/filesystems/ufs.txt

4 of them related to the two fs patches applied today.

I'll send you a fix together with the remaining patches in a few.

Thanks,
Mauro
Jonathan Corbet July 31, 2019, 8:02 p.m. UTC | #5
On Wed, 31 Jul 2019 16:58:59 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:

> > - [PATCH v2 07/26] docs: w1: convert to ReST and add to the kAPI group of
> >   docs
> > 
> > 	Gives me the dreaded "could not build fake ancestor" error, I
> > 	don't really understand why.  
> 
> That's new! What Sphinx version are you using?

That's a "git am" error, sphinx doesn't enter into the picture...

jon
diff mbox series

Patch

diff --git a/Documentation/index.rst b/Documentation/index.rst
index 70ae148ec980..230e550e9741 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -111,6 +111,7 @@  needed).
    netlabel/index
    networking/index
    pcmcia/index
+   power/index
    target/index
    timers/index
    watchdog/index
diff --git a/Documentation/power/index.rst b/Documentation/power/index.rst
index 20415f21e48a..002e42745263 100644
--- a/Documentation/power/index.rst
+++ b/Documentation/power/index.rst
@@ -1,4 +1,4 @@ 
-:orphan:
+.. SPDX-License-Identifier: GPL-2.0
 
 ================
 Power Management