diff mbox series

[v3,02/47,DO-NOT-MERGE] docs: repair broken references

Message ID 20200925002900.465855-3-jsnow@redhat.com
State New
Headers show
Series qapi: static typing conversion, pt1 | expand

Commit Message

John Snow Sept. 25, 2020, 12:28 a.m. UTC
Signed-off-by: John Snow <jsnow@redhat.com>
---
 docs/devel/multi-thread-tcg.rst | 2 +-
 docs/devel/testing.rst          | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Comments

Cleber Rosa Sept. 29, 2020, 2:48 a.m. UTC | #1
On Thu, Sep 24, 2020 at 08:28:15PM -0400, John Snow wrote:
> Signed-off-by: John Snow <jsnow@redhat.com>

Reviewed-by: Cleber Rosa <crosa@redhat.com>
Cleber Rosa Sept. 29, 2020, 3:14 a.m. UTC | #2
On Thu, Sep 24, 2020 at 08:28:15PM -0400, John Snow wrote:
> Signed-off-by: John Snow <jsnow@redhat.com>
> ---
>  docs/devel/multi-thread-tcg.rst | 2 +-
>  docs/devel/testing.rst          | 2 +-
>  2 files changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/devel/multi-thread-tcg.rst b/docs/devel/multi-thread-tcg.rst
> index 21483870db..92a9eba13c 100644
> --- a/docs/devel/multi-thread-tcg.rst
> +++ b/docs/devel/multi-thread-tcg.rst
> @@ -267,7 +267,7 @@ of view of external observers (e.g. another processor core). They can
>  apply to any memory operations as well as just loads or stores.
>  
>  The Linux kernel has an excellent `write-up
> -<https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/plain/Documentation/memory-barriers.txt>`
> +<https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/plain/Documentation/memory-barriers.txt>`_
>  on the various forms of memory barrier and the guarantees they can
>  provide.
>  
> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
> index 666c4d7240..f21f3f58eb 100644
> --- a/docs/devel/testing.rst
> +++ b/docs/devel/testing.rst
> @@ -953,7 +953,7 @@ compiler flags are needed to build for a given target.
>  If you have the ability to run containers as the user you can also
>  take advantage of the build systems "Docker" support. It will then use
>  containers to build any test case for an enabled guest where there is
> -no system compiler available. See :ref: `_docker-ref` for details.
> +no system compiler available. See `docker-ref` for details.
>

Actually, I take the "r-b" back because I missed this line... it
should be:

   no system compiler available. See `docker-ref`_ for details.

- Cleber.
John Snow Sept. 29, 2020, 3:30 p.m. UTC | #3
On 9/28/20 11:14 PM, Cleber Rosa wrote:
> On Thu, Sep 24, 2020 at 08:28:15PM -0400, John Snow wrote:
>> Signed-off-by: John Snow <jsnow@redhat.com>
>> ---
>>   docs/devel/multi-thread-tcg.rst | 2 +-
>>   docs/devel/testing.rst          | 2 +-
>>   2 files changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/docs/devel/multi-thread-tcg.rst b/docs/devel/multi-thread-tcg.rst
>> index 21483870db..92a9eba13c 100644
>> --- a/docs/devel/multi-thread-tcg.rst
>> +++ b/docs/devel/multi-thread-tcg.rst
>> @@ -267,7 +267,7 @@ of view of external observers (e.g. another processor core). They can
>>   apply to any memory operations as well as just loads or stores.
>>   
>>   The Linux kernel has an excellent `write-up
>> -<https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/plain/Documentation/memory-barriers.txt>`
>> +<https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/plain/Documentation/memory-barriers.txt>`_
>>   on the various forms of memory barrier and the guarantees they can
>>   provide.
>>   
>> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
>> index 666c4d7240..f21f3f58eb 100644
>> --- a/docs/devel/testing.rst
>> +++ b/docs/devel/testing.rst
>> @@ -953,7 +953,7 @@ compiler flags are needed to build for a given target.
>>   If you have the ability to run containers as the user you can also
>>   take advantage of the build systems "Docker" support. It will then use
>>   containers to build any test case for an enabled guest where there is
>> -no system compiler available. See :ref: `_docker-ref` for details.
>> +no system compiler available. See `docker-ref` for details.
>>
> 
> Actually, I take the "r-b" back because I missed this line... it
> should be:
> 
>     no system compiler available. See `docker-ref`_ for details.
> 
> - Cleber.
> 

I can send that as a *real* patch to fix it *right now*, but it actually 
works just fine using the "any" role.

(Or, it did for me.)

--js
John Snow Sept. 29, 2020, 6:16 p.m. UTC | #4
On 9/28/20 11:14 PM, Cleber Rosa wrote:
> On Thu, Sep 24, 2020 at 08:28:15PM -0400, John Snow wrote:
>> Signed-off-by: John Snow <jsnow@redhat.com>
>> ---
>>   docs/devel/multi-thread-tcg.rst | 2 +-
>>   docs/devel/testing.rst          | 2 +-
>>   2 files changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/docs/devel/multi-thread-tcg.rst b/docs/devel/multi-thread-tcg.rst
>> index 21483870db..92a9eba13c 100644
>> --- a/docs/devel/multi-thread-tcg.rst
>> +++ b/docs/devel/multi-thread-tcg.rst
>> @@ -267,7 +267,7 @@ of view of external observers (e.g. another processor core). They can
>>   apply to any memory operations as well as just loads or stores.
>>   
>>   The Linux kernel has an excellent `write-up
>> -<https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/plain/Documentation/memory-barriers.txt>`
>> +<https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/plain/Documentation/memory-barriers.txt>`_
>>   on the various forms of memory barrier and the guarantees they can
>>   provide.
>>   
>> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
>> index 666c4d7240..f21f3f58eb 100644
>> --- a/docs/devel/testing.rst
>> +++ b/docs/devel/testing.rst
>> @@ -953,7 +953,7 @@ compiler flags are needed to build for a given target.
>>   If you have the ability to run containers as the user you can also
>>   take advantage of the build systems "Docker" support. It will then use
>>   containers to build any test case for an enabled guest where there is
>> -no system compiler available. See :ref: `_docker-ref` for details.
>> +no system compiler available. See `docker-ref` for details.
>>
> 
> Actually, I take the "r-b" back because I missed this line... it
> should be:
> 
>     no system compiler available. See `docker-ref`_ for details.
> 
> - Cleber.
> 

I'm reworking this patch and dropping the DO-NOT-MERGE and fixing this 
reference to read:

:ref:`docker-ref`

This works *without* my other sphinx patches, so it should now stand alone.

I've sent this as a standalone patch to qemu-trivial.

(I'll fix it in this branch too, but it's DO-NOT-MERGE here, so ... 
whatever!)

--js
diff mbox series

Patch

diff --git a/docs/devel/multi-thread-tcg.rst b/docs/devel/multi-thread-tcg.rst
index 21483870db..92a9eba13c 100644
--- a/docs/devel/multi-thread-tcg.rst
+++ b/docs/devel/multi-thread-tcg.rst
@@ -267,7 +267,7 @@  of view of external observers (e.g. another processor core). They can
 apply to any memory operations as well as just loads or stores.
 
 The Linux kernel has an excellent `write-up
-<https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/plain/Documentation/memory-barriers.txt>`
+<https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/plain/Documentation/memory-barriers.txt>`_
 on the various forms of memory barrier and the guarantees they can
 provide.
 
diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
index 666c4d7240..f21f3f58eb 100644
--- a/docs/devel/testing.rst
+++ b/docs/devel/testing.rst
@@ -953,7 +953,7 @@  compiler flags are needed to build for a given target.
 If you have the ability to run containers as the user you can also
 take advantage of the build systems "Docker" support. It will then use
 containers to build any test case for an enabled guest where there is
-no system compiler available. See :ref: `_docker-ref` for details.
+no system compiler available. See `docker-ref` for details.
 
 Running subset of tests
 -----------------------