[bootconfig,3/3] doc: Add /proc/bootconfig to proc.rst

Message ID 20231005171747.541123-3-paulmck@kernel.org
State New
Headers
Series Expose boot-loader kernel command-line arguments |

Commit Message

Paul E. McKenney Oct. 5, 2023, 5:17 p.m. UTC
  Add /proc/bootconfig description to Documentation/filesystems/proc.rst.

Reported-by: Masami Hiramatsu <mhiramat@kernel.org>
Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
---
 Documentation/filesystems/proc.rst | 5 +++++
 1 file changed, 5 insertions(+)
  

Comments

Masami Hiramatsu (Google) Oct. 7, 2023, 1:51 a.m. UTC | #1
On Thu,  5 Oct 2023 10:17:47 -0700
"Paul E. McKenney" <paulmck@kernel.org> wrote:

> Add /proc/bootconfig description to Documentation/filesystems/proc.rst.
> 
> Reported-by: Masami Hiramatsu <mhiramat@kernel.org>
> Signed-off-by: Paul E. McKenney <paulmck@kernel.org>
> Acked-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
> ---
>  Documentation/filesystems/proc.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
> index 5703b0e87cbe..a2c160f29632 100644
> --- a/Documentation/filesystems/proc.rst
> +++ b/Documentation/filesystems/proc.rst
> @@ -689,6 +689,11 @@ files are there, and which are missing.
>   File         Content
>   ============ ===============================================================
>   apm          Advanced power management info
> + bootconfig   Kernel command line obtained from boot config,
> + 	      and, if there were kernel parameters from the
> +	      boot loader, a "# Parameters from bootloader:"
> +	      line followed by a line containing those
> +	      parameters prefixed by "# ".			(5.5)

Ditto. Curiously, in this part of the document, the tail spaces until "(5.5)"
are using tabs, but the head spaces are using whitespaces. So updated it.
I noticed that a warning message when I imported it to my bootconfig/for-next
branch.

Thank you,

>   buddyinfo    Kernel memory allocator information (see text)	(2.5)
>   bus          Directory containing bus specific information
>   cmdline      Kernel command line, both from bootloader and embedded
> -- 
> 2.40.1
>
  

Patch

diff --git a/Documentation/filesystems/proc.rst b/Documentation/filesystems/proc.rst
index 5703b0e87cbe..a2c160f29632 100644
--- a/Documentation/filesystems/proc.rst
+++ b/Documentation/filesystems/proc.rst
@@ -689,6 +689,11 @@  files are there, and which are missing.
  File         Content
  ============ ===============================================================
  apm          Advanced power management info
+ bootconfig   Kernel command line obtained from boot config,
+ 	      and, if there were kernel parameters from the
+	      boot loader, a "# Parameters from bootloader:"
+	      line followed by a line containing those
+	      parameters prefixed by "# ".			(5.5)
  buddyinfo    Kernel memory allocator information (see text)	(2.5)
  bus          Directory containing bus specific information
  cmdline      Kernel command line, both from bootloader and embedded