[PATCH] docs: admin-guide: Add description of %c corename format

[PATCH] docs: admin-guide: Add description of %c corename format

[d.hatayama]

There is somehow no description of %c corename format specifier for
/proc/sys/kernel/core_pattern. The %c corename format specifier is
used by user-space application such as systemd-coredump, so it should
be documented.

To find where %c is handled in the kernel source code, look at
function format_corename() in fs/coredump.c.

Signed-off-by: HATAYAMA Daisuke <d.hatayama@fujitsu.com>
---
 Documentation/admin-guide/sysctl/kernel.rst | 1 +
 1 file changed, 1 insertion(+)

diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
index def0748..4557907 100644
--- a/Documentation/admin-guide/sysctl/kernel.rst
+++ b/Documentation/admin-guide/sysctl/kernel.rst
@@ -213,6 +213,7 @@ core_pattern is used to specify a core dumpfile pattern name.
        %h      hostname
        %e      executable filename (may be shortened)
        %E      executable path
+       %c      maximum size of core file by resource limit RLIMIT_CORE
        %<OTHER> both are dropped

 * If the first character of the pattern is a '|', the kernel will treat
--
1.8.3.1

Re: [PATCH] docs: admin-guide: Add description of %c corename format

[Jonathan Corbet]

On Fri, 7 Feb 2020 11:01:07 +0000
"d.hatayama@fujitsu.com" <d.hatayama@fujitsu.com> wrote:

> There is somehow no description of %c corename format specifier for
> /proc/sys/kernel/core_pattern. The %c corename format specifier is
> used by user-space application such as systemd-coredump, so it should
> be documented.
> 
> To find where %c is handled in the kernel source code, look at
> function format_corename() in fs/coredump.c.
> 
> Signed-off-by: HATAYAMA Daisuke <d.hatayama@fujitsu.com>
> ---
>  Documentation/admin-guide/sysctl/kernel.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/Documentation/admin-guide/sysctl/kernel.rst b/Documentation/admin-guide/sysctl/kernel.rst
> index def0748..4557907 100644
> --- a/Documentation/admin-guide/sysctl/kernel.rst
> +++ b/Documentation/admin-guide/sysctl/kernel.rst
> @@ -213,6 +213,7 @@ core_pattern is used to specify a core dumpfile pattern name.
>         %h      hostname
>         %e      executable filename (may be shortened)
>         %E      executable path
> +       %c      maximum size of core file by resource limit RLIMIT_CORE
>         %<OTHER> both are dropped
> 
>  * If the first character of the pattern is a '|', the kernel will treat

Applied, thanks.  A couple of notes:

 - The patch was whitespace corrupted; I worked around that.
 - There is no need to resend after five days; it can take me a little
   while to catch up sometimes.

jon