linux-kernel - Re: [PATCH v2 25/79] docs: convert docs to ReST and rename to *.rst

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Mon, 22 Apr 2019 11:07:54 -0300
From:   Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
To:     Bjorn Helgaas <bhelgaas@...gle.com>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Linux PCI <linux-pci@...r.kernel.org>,
        linux-wireless <linux-wireless@...r.kernel.org>,
        Changbin Du <changbin.du@...il.com>
Subject: Re: [PATCH v2 25/79] docs: convert docs to ReST and rename to *.rst

Em Mon, 22 Apr 2019 08:48:10 -0500
Bjorn Helgaas <bhelgaas@...gle.com> escreveu:

> [+cc Changbin, -cc many others]
> 
> On Mon, Apr 22, 2019 at 8:28 AM Mauro Carvalho Chehab
> <mchehab+samsung@...nel.org> wrote:
> >
> > Convert the PM documents to ReST, in order to allow them to
> > build with Sphinx.
> >
> > The conversion is actually:
> >   - add blank lines and identation in order to identify paragraphs;  
> 
> s/identation/indentation/
> 
> >   - fix tables markups;
> >   - add some lists markups;
> >   - mark literal blocks;
> >   - adjust title markups.
> >
> > At its new index.rst, let's add a :orphan: while this is not linked to
> > the main index.rst file, in order to avoid build warnings.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@...nel.org>  
> 
> The PCI part of this is fine with me but may conflict with Changbin's work:
> 
> https://lore.kernel.org/lkml/20190409155626.6049-1-changbin.du@gmail.com

Yes it could generate a conflict, but it is a trivial change:

--- a/Documentation/PCI/pci.txt
+++ b/Documentation/PCI/pci.txt
@@ -110,7 +110,7 @@ initialization with a pointer to a structure describing the driver
 	resume_early	Wake device from low power state.
 	resume		Wake device from low power state.
 
-		(Please see Documentation/power/pci.txt for descriptions
+		(Please see Documentation/power/pci.rst for descriptions
 		of PCI Power Management and the related functions.)
 
 	shutdown	Hook into reboot_notifier_list (kernel/sys.c).

Looking at Changbin's patch 02/12 v3:

	https://lore.kernel.org/lkml/20190409155626.6049-3-changbin.du@gmail.com/

It doesn't touch the above line, nor the context lines, and it doesn't 
change more than 50% of the file. So, even if this patch gets merged
after the PCI changeset, git will very likely recognize it as a
rename and will apply it anyway.

> Since this doesn't look like it's targeting merge via the PCI tree,
> I'll let you two work out any conflicts.
> 
> Acked-by: Bjorn Helgaas <bhelgaas@...gle.com>

Thanks!
Mauro