diff mbox series

doc: Adjusting tags in release notes to eliminate global conflict

Message ID CAPv=uV7hE0PkvN6Mxb54XEKxSQJrOMZDRYC2aK-L5w60WPJmBw@mail.gmail.com
State Superseded
Headers show
Series doc: Adjusting tags in release notes to eliminate global conflict | expand

Checks

Context Check Description
snowpatch_ozlabs/apply_patch warning master/apply_patch Patch failed to apply
snowpatch_ozlabs/apply_patch fail Failed to apply to any branch

Commit Message

Jeff Scheel Feb. 5, 2019, 1:26 p.m. UTC
Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
---
 doc/release-notes/skiboot-5.7-rc1.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

PHB4 <capi2-rn-rc1>`)

 New feature for IBM FSP based systems:

@@ -258,7 +258,7 @@ PCI/PHB4
   operations) is only available with P9 DD2. A new patch will be provided
   to support this feature.

-.. _capi2-rn:
+.. _capi2-rn-rc1:

 - phb4 capi (i.e. CAPI2): Enable capi mode for PHB4

@@ -304,7 +304,7 @@ PCI/PHB4

   Only partially tested and contends with some DD1 errata, but it's a
start.

-.. _shared-slot-rn:
+.. _shared-slot-rn-rc1:

 - phb4: Activate shared PCI slot on witherspoon

Comments

Vasant Hegde Feb. 5, 2019, 2:54 p.m. UTC | #1
On 02/05/2019 06:56 PM, Jeff Scheel wrote:
> Signed-off-by: Jeff Scheel <scheel@us.ibm.com>

Can you please add small description about the conflict.. so that it makes easy 
to review.

-Vasant
Jeff Scheel Feb. 5, 2019, 5:50 p.m. UTC | #2
Vasant, I'm not sure what you mean by "add comments".  The tags are
self-consistent in the document in that they are defined and referenced all
in the same file.

If your question is what file also contains the conflicting tags, they are
in skiboot-5.7.rst.  I'll plead ignorance as to how these files are
created, but they almost appear to be copy & paste errors between the two
files.  If the project is going to support build modes such as "singlehtml"
for documentation, these labels need to be unique.

Hope that answers your question.
-Jeff

On Tue, Feb 5, 2019 at 8:54 AM Vasant Hegde <hegdevasant@linux.vnet.ibm.com>
wrote:

> On 02/05/2019 06:56 PM, Jeff Scheel wrote:
> > Signed-off-by: Jeff Scheel <scheel@us.ibm.com>
>
> Can you please add small description about the conflict.. so that it makes
> easy
> to review.
>
> -Vasant
>
>
<div dir="ltr"><div dir="ltr"><div>Vasant, I&#39;m not sure what you mean by &quot;add comments&quot;.  The tags are self-consistent in the document in that they are defined and referenced all in the same file.</div><div><br></div><div>If your question is what file also contains the conflicting tags, they are in skiboot-5.7.rst.  I&#39;ll plead ignorance as to how these files are created, but they almost appear to be copy &amp; paste errors between the two files.  If the project is going to support build modes such as &quot;singlehtml&quot; for documentation, these labels need to be unique.</div><div><br></div><div>Hope that answers your question.</div><div>-Jeff<br></div></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Feb 5, 2019 at 8:54 AM Vasant Hegde &lt;<a href="mailto:hegdevasant@linux.vnet.ibm.com">hegdevasant@linux.vnet.ibm.com</a>&gt; wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">On 02/05/2019 06:56 PM, Jeff Scheel wrote:<br>
&gt; Signed-off-by: Jeff Scheel &lt;<a href="mailto:scheel@us.ibm.com" target="_blank">scheel@us.ibm.com</a>&gt;<br>
<br>
Can you please add small description about the conflict.. so that it makes easy <br>
to review.<br>
<br>
-Vasant<br>
<br>
</blockquote></div>
Andrew Donnellan Feb. 5, 2019, 11:07 p.m. UTC | #3
On 6/2/19 4:50 am, Jeff Scheel wrote:
> Vasant, I'm not sure what you mean by "add comments".  The tags are 
> self-consistent in the document in that they are defined and referenced 
> all in the same file.

The change should be described in the commit message to explain what the 
issue is - generally skiboot (+ Linux kernel) patches are required to 
use the first line of the commit message as a "summary", and then at 
least a sentence or two explaining in more detail what the change is.


Andrew


> 
> If your question is what file also contains the conflicting tags, they 
> are in skiboot-5.7.rst.  I'll plead ignorance as to how these files are 
> created, but they almost appear to be copy & paste errors between the 
> two files.  If the project is going to support build modes such as 
> "singlehtml" for documentation, these labels need to be unique.
> 
> Hope that answers your question.
> -Jeff
> 
> On Tue, Feb 5, 2019 at 8:54 AM Vasant Hegde 
> <hegdevasant@linux.vnet.ibm.com <mailto:hegdevasant@linux.vnet.ibm.com>> 
> wrote:
> 
>     On 02/05/2019 06:56 PM, Jeff Scheel wrote:
>      > Signed-off-by: Jeff Scheel <scheel@us.ibm.com
>     <mailto:scheel@us.ibm.com>>
> 
>     Can you please add small description about the conflict.. so that it
>     makes easy
>     to review.
> 
>     -Vasant
> 
> 
> _______________________________________________
> Skiboot mailing list
> Skiboot@lists.ozlabs.org
> https://lists.ozlabs.org/listinfo/skiboot
>
diff mbox series

Patch

diff --git a/doc/release-notes/skiboot-5.7-rc1.rst
b/doc/release-notes/skiboot-5.7-rc1.rst
index 28737f6b..b6a0d10d 100644
--- a/doc/release-notes/skiboot-5.7-rc1.rst
+++ b/doc/release-notes/skiboot-5.7-rc1.rst
@@ -31,8 +31,8 @@  New Features
 New features in this release for POWER9 systems:

 - In Memory Counters (IMC) (See :ref:`imc` for details)
-- phb4: Activate shared PCI slot on witherspoon (see :ref:`Shared Slot
<shared-slot-rn>`)
-- phb4 capi (i.e. CAPI2): Enable capi mode for PHB4 (see :ref:`CAPI on
PHB4 <capi2-rn>`)
+- phb4: Activate shared PCI slot on witherspoon (see :ref:`Shared Slot
<shared-slot-rn-rc1>`)
+- phb4 capi (i.e. CAPI2): Enable capi mode for PHB4 (see :ref:`CAPI on