linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH net-next RESEND] Documentation: rxrpc: Demote three sections
@ 2025-09-22 12:41 Bagas Sanjaya
  2025-09-23  8:34 ` Simon Horman
                   ` (2 more replies)
  0 siblings, 3 replies; 4+ messages in thread
From: Bagas Sanjaya @ 2025-09-22 12:41 UTC (permalink / raw)
  To: Linux Kernel Mailing List, Linux Documentation, Linux Networking,
	Linux AFS
  Cc: David Howells, Marc Dionne, David S. Miller, Eric Dumazet,
	Jakub Kicinski, Paolo Abeni, Simon Horman, Jonathan Corbet,
	Bagas Sanjaya

Three sections ("Socket Options", "Security", and "Example Client Usage")
use title headings, which increase number of entries in the networking
docs toctree by three, and also make the rest of sections headed under
"Example Client Usage".

Demote these sections back to section headings.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Documentation/networking/rxrpc.rst | 9 +++------
 1 file changed, 3 insertions(+), 6 deletions(-)

diff --git a/Documentation/networking/rxrpc.rst b/Documentation/networking/rxrpc.rst
index d63e3e27dd06be..8926dab8e2e60d 100644
--- a/Documentation/networking/rxrpc.rst
+++ b/Documentation/networking/rxrpc.rst
@@ -437,8 +437,7 @@ message type supported.  At run time this can be queried by means of the
 RXRPC_SUPPORTED_CMSG socket option (see below).
 
 
-==============
-SOCKET OPTIONS
+Socket Options
 ==============
 
 AF_RXRPC sockets support a few socket options at the SOL_RXRPC level:
@@ -495,8 +494,7 @@ AF_RXRPC sockets support a few socket options at the SOL_RXRPC level:
      the highest control message type supported.
 
 
-========
-SECURITY
+Security
 ========
 
 Currently, only the kerberos 4 equivalent protocol has been implemented
@@ -540,8 +538,7 @@ be found at:
 	http://people.redhat.com/~dhowells/rxrpc/listen.c
 
 
-====================
-EXAMPLE CLIENT USAGE
+Example Client Usage
 ====================
 
 A client would issue an operation by:
-- 
An old man doll... just what I always wanted! - Clara


^ permalink raw reply related	[flat|nested] 4+ messages in thread

* Re: [PATCH net-next RESEND] Documentation: rxrpc: Demote three sections
  2025-09-22 12:41 [PATCH net-next RESEND] Documentation: rxrpc: Demote three sections Bagas Sanjaya
@ 2025-09-23  8:34 ` Simon Horman
  2025-09-24 10:39 ` David Howells
  2025-09-25  1:20 ` patchwork-bot+netdevbpf
  2 siblings, 0 replies; 4+ messages in thread
From: Simon Horman @ 2025-09-23  8:34 UTC (permalink / raw)
  To: Bagas Sanjaya
  Cc: Linux Kernel Mailing List, Linux Documentation, Linux Networking,
	Linux AFS, David Howells, Marc Dionne, David S. Miller,
	Eric Dumazet, Jakub Kicinski, Paolo Abeni, Jonathan Corbet

On Mon, Sep 22, 2025 at 07:41:37PM +0700, Bagas Sanjaya wrote:
> Three sections ("Socket Options", "Security", and "Example Client Usage")
> use title headings, which increase number of entries in the networking
> docs toctree by three, and also make the rest of sections headed under
> "Example Client Usage".
> 
> Demote these sections back to section headings.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Thanks,

I looked at the output of make htmldocs in a browser. I agree that both
the entries in index.html and the header arrangement in rxrpc.html make
more sense with this change.

Reviewed-by: Simon Horman <horms@kernel.org>

^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH net-next RESEND] Documentation: rxrpc: Demote three sections
  2025-09-22 12:41 [PATCH net-next RESEND] Documentation: rxrpc: Demote three sections Bagas Sanjaya
  2025-09-23  8:34 ` Simon Horman
@ 2025-09-24 10:39 ` David Howells
  2025-09-25  1:20 ` patchwork-bot+netdevbpf
  2 siblings, 0 replies; 4+ messages in thread
From: David Howells @ 2025-09-24 10:39 UTC (permalink / raw)
  To: Bagas Sanjaya
  Cc: dhowells, Linux Kernel Mailing List, Linux Documentation,
	Linux Networking, Linux AFS, Marc Dionne, David S. Miller,
	Eric Dumazet, Jakub Kicinski, Paolo Abeni, Simon Horman,
	Jonathan Corbet

Bagas Sanjaya <bagasdotme@gmail.com> wrote:

> Three sections ("Socket Options", "Security", and "Example Client Usage")
> use title headings, which increase number of entries in the networking
> docs toctree by three, and also make the rest of sections headed under
> "Example Client Usage".
> 
> Demote these sections back to section headings.
> 
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Acked-by: David Howells <dhowells@redhat.com>


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [PATCH net-next RESEND] Documentation: rxrpc: Demote three sections
  2025-09-22 12:41 [PATCH net-next RESEND] Documentation: rxrpc: Demote three sections Bagas Sanjaya
  2025-09-23  8:34 ` Simon Horman
  2025-09-24 10:39 ` David Howells
@ 2025-09-25  1:20 ` patchwork-bot+netdevbpf
  2 siblings, 0 replies; 4+ messages in thread
From: patchwork-bot+netdevbpf @ 2025-09-25  1:20 UTC (permalink / raw)
  To: Bagas Sanjaya
  Cc: linux-kernel, linux-doc, netdev, linux-afs, dhowells, marc.dionne,
	davem, edumazet, kuba, pabeni, horms, corbet

Hello:

This patch was applied to netdev/net-next.git (main)
by Jakub Kicinski <kuba@kernel.org>:

On Mon, 22 Sep 2025 19:41:37 +0700 you wrote:
> Three sections ("Socket Options", "Security", and "Example Client Usage")
> use title headings, which increase number of entries in the networking
> docs toctree by three, and also make the rest of sections headed under
> "Example Client Usage".
> 
> Demote these sections back to section headings.
> 
> [...]

Here is the summary with links:
  - [net-next,RESEND] Documentation: rxrpc: Demote three sections
    https://git.kernel.org/netdev/net-next/c/5de92bd0d754

You are awesome, thank you!
-- 
Deet-doot-dot, I am a bot.
https://korg.docs.kernel.org/patchwork/pwbot.html



^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2025-09-25  1:20 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-09-22 12:41 [PATCH net-next RESEND] Documentation: rxrpc: Demote three sections Bagas Sanjaya
2025-09-23  8:34 ` Simon Horman
2025-09-24 10:39 ` David Howells
2025-09-25  1:20 ` patchwork-bot+netdevbpf

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).