[PATCH] docs: driver-api: remove a duplicated index entry

[PATCH] docs: driver-api: remove a duplicated index entry

[Mauro Carvalho Chehab]

The ipmb file was added twice at index.rst. That
sounds to be because the same patch was applied twice,
via different git trees:

	commit f6ae22d64433fd8e08654adad7966299da931bb9
	Author: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
	Commit: Jonathan Corbet <corbet@lwn.net>

	    docs: ipmb: place it at driver-api and convert to ReST

	commit ac499fba98c3c65078fd84fa0a62cd6f6d5837ed
	Author: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
	Commit: Corey Minyard <cminyard@mvista.com>

	    docs: ipmb: place it at driver-api and convert to ReST

With Sphinx 4.0.0 development tree, a new warning is produced
due to that:

	.../Documentation/driver-api/index.rst:14: WARNING: duplicated entry found in toctree: driver-api/ipmb

The fix is trivial: just drop the duplicated line.

Fixes: f6ae22d64433 ("docs: ipmb: place it at driver-api and convert to ReST")
Fixes: ac499fba98c3 ("docs: ipmb: place it at driver-api and convert to ReST")
Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/driver-api/index.rst | 1 -
 1 file changed, 1 deletion(-)

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 987d6e74ea6a..f357f3eb400c 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -77,7 +77,6 @@ available subsections can be seen below.
    console
    dcdbas
    eisa
-   ipmb
    isa
    isapnp
    io-mapping
-- 
2.26.2

Re: [PATCH] docs: driver-api: remove a duplicated index entry

[Jonathan Corbet]

On Thu, 15 Oct 2020 11:12:06 +0200
Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:

> The ipmb file was added twice at index.rst. That
> sounds to be because the same patch was applied twice,
> via different git trees:
> 
> 	commit f6ae22d64433fd8e08654adad7966299da931bb9
> 	Author: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> 	Commit: Jonathan Corbet <corbet@lwn.net>
> 
> 	    docs: ipmb: place it at driver-api and convert to ReST
> 
> 	commit ac499fba98c3c65078fd84fa0a62cd6f6d5837ed
> 	Author: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> 	Commit: Corey Minyard <cminyard@mvista.com>
> 
> 	    docs: ipmb: place it at driver-api and convert to ReST
> 
> With Sphinx 4.0.0 development tree, a new warning is produced
> due to that:
> 
> 	.../Documentation/driver-api/index.rst:14: WARNING: duplicated entry found in toctree: driver-api/ipmb
> 
> The fix is trivial: just drop the duplicated line.
> 
> Fixes: f6ae22d64433 ("docs: ipmb: place it at driver-api and convert to ReST")
> Fixes: ac499fba98c3 ("docs: ipmb: place it at driver-api and convert to ReST")
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>

Interesting...I wonder how applying the patch twice could lead to the line
being inserted in two completely different locations like that?  Anyway,
I've applied this one, hopefully nobody else will do the same :)

Thanks,

jon

Re: [PATCH] docs: driver-api: remove a duplicated index entry

[Mauro Carvalho Chehab]

Em Wed, 21 Oct 2020 15:13:44 -0600
Jonathan Corbet <corbet@lwn.net> escreveu:

> On Thu, 15 Oct 2020 11:12:06 +0200
> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> wrote:
> 
> > The ipmb file was added twice at index.rst. That
> > sounds to be because the same patch was applied twice,
> > via different git trees:
> > 
> > 	commit f6ae22d64433fd8e08654adad7966299da931bb9
> > 	Author: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > 	Commit: Jonathan Corbet <corbet@lwn.net>
> > 
> > 	    docs: ipmb: place it at driver-api and convert to ReST
> > 
> > 	commit ac499fba98c3c65078fd84fa0a62cd6f6d5837ed
> > 	Author: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > 	Commit: Corey Minyard <cminyard@mvista.com>
> > 
> > 	    docs: ipmb: place it at driver-api and convert to ReST
> > 
> > With Sphinx 4.0.0 development tree, a new warning is produced
> > due to that:
> > 
> > 	.../Documentation/driver-api/index.rst:14: WARNING: duplicated entry found in toctree: driver-api/ipmb
> > 
> > The fix is trivial: just drop the duplicated line.
> > 
> > Fixes: f6ae22d64433 ("docs: ipmb: place it at driver-api and convert to ReST")
> > Fixes: ac499fba98c3 ("docs: ipmb: place it at driver-api and convert to ReST")
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>  
> 
> Interesting...I wonder how applying the patch twice could lead to the line
> being inserted in two completely different locations like that?  Anyway,
> I've applied this one, hopefully nobody else will do the same :)

Probably this was due to some manual conflict resolution when applying
one of the versions of it ;-)

No big harm, and with newer Sphinx versions, we should be able 
to detect similar cases in the future.

Thanks,
Mauro