[PATCH v2 6/7] docs: Expand the front-page CPU-architecture section

Jonathan Corbet posted 4 patches 3 years, 6 months ago
There is a newer version of this series
[PATCH v2 6/7] docs: Expand the front-page CPU-architecture section
Posted by Jonathan Corbet 3 years, 6 months ago
Actually show the entries for individual architectures, since otherwise a
single line reading "CPU architectures" is not very enlightening.

We should really move all of the architecture directories under an arch/
directory, as we do with the top-level directory, but that's a task for
another day.

Signed-off-by: Jonathan Corbet <corbet@lwn.net>
---
 Documentation/index.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/index.rst b/Documentation/index.rst
index 6d01c2e38573..5a700548ae82 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -93,7 +93,7 @@ Architecture-specific documentation
 -----------------------------------
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    arch
 
-- 
2.37.2
Re: [PATCH v2 6/7] docs: Expand the front-page CPU-architecture section
Posted by David Vernet 3 years, 6 months ago
On Thu, Sep 22, 2022 at 02:41:37PM -0600, Jonathan Corbet wrote:
> Actually show the entries for individual architectures, since otherwise a
> single line reading "CPU architectures" is not very enlightening.
> 
> We should really move all of the architecture directories under an arch/
> directory, as we do with the top-level directory, but that's a task for
> another day.
> 
> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
> ---
>  Documentation/index.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index 6d01c2e38573..5a700548ae82 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -93,7 +93,7 @@ Architecture-specific documentation
>  -----------------------------------
>  
>  .. toctree::
> -   :maxdepth: 1
> +   :maxdepth: 2

Wasn't this changed from 2 -> 1 in patch 2/7 [0] of this set? If so, can
we just undo that adjustment and remove this patch from the series?

[0]: https://lore.kernel.org/all/20220922204138.153146-3-corbet@lwn.net/
Re: [PATCH v2 6/7] docs: Expand the front-page CPU-architecture section
Posted by Jonathan Corbet 3 years, 6 months ago
David Vernet <void@manifault.com> writes:

> On Thu, Sep 22, 2022 at 02:41:37PM -0600, Jonathan Corbet wrote:
>> Actually show the entries for individual architectures, since otherwise a
>> single line reading "CPU architectures" is not very enlightening.
>> 
>> We should really move all of the architecture directories under an arch/
>> directory, as we do with the top-level directory, but that's a task for
>> another day.
>> 
>> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
>> ---
>>  Documentation/index.rst | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>> 
>> diff --git a/Documentation/index.rst b/Documentation/index.rst
>> index 6d01c2e38573..5a700548ae82 100644
>> --- a/Documentation/index.rst
>> +++ b/Documentation/index.rst
>> @@ -93,7 +93,7 @@ Architecture-specific documentation
>>  -----------------------------------
>>  
>>  .. toctree::
>> -   :maxdepth: 1
>> +   :maxdepth: 2
>
> Wasn't this changed from 2 -> 1 in patch 2/7 [0] of this set? If so, can
> we just undo that adjustment and remove this patch from the series?
>
> [0]: https://lore.kernel.org/all/20220922204138.153146-3-corbet@lwn.net/

Yup, that does make more sense.  I plead jet lag...

Thanks,

jon