Re: [PATCHv3 3/3] kernel: add sysfs documentation for live patching

[Masami Hiramatsu <masami.hiramatsu.pt@hitachi.com>]

(2014/11/21 7:29), Seth Jennings wrote:
> Adds sysfs interface documentation to Documentation/ABI/testing/
> 

Hmm, is there any reason to decouple this documentation from code patch?
I think we'd better merge this to 2/3, or move sysfs interface code from 2/3 to this.

Thank you,

> Signed-off-by: Seth Jennings <sjenning@redhat.com>
> ---
>  Documentation/ABI/testing/sysfs-kernel-livepatch | 44 ++++++++++++++++++++++++
>  MAINTAINERS                                      |  1 +
>  2 files changed, 45 insertions(+)
>  create mode 100644 Documentation/ABI/testing/sysfs-kernel-livepatch
> 
> diff --git a/Documentation/ABI/testing/sysfs-kernel-livepatch b/Documentation/ABI/testing/sysfs-kernel-livepatch
> new file mode 100644
> index 0000000..5bf42a8
> --- /dev/null
> +++ b/Documentation/ABI/testing/sysfs-kernel-livepatch
> @@ -0,0 +1,44 @@
> +What:		/sys/kernel/livepatch
> +Date:		Nov 2014
> +KernelVersion:	3.19.0
> +Contact:	live-patching@vger.kernel.org
> +Description:
> +		Interface for kernel live patching
> +
> +		The /sys/kernel/livepatch directory contains subdirectories for
> +		each loaded live patch module.
> +
> +What:		/sys/kernel/livepatch/<patch>
> +Date:		Nov 2014
> +KernelVersion:	3.19.0
> +Contact:	live-patching@vger.kernel.org
> +Description:
> +		The patch directory contains subdirectories for each kernel
> +		object (vmlinux or a module) in which it patched functions.
> +
> +What:		/sys/kernel/livepatch/<patch>/enabled
> +Date:		Nov 2014
> +KernelVersion:	3.19.0
> +Contact:	live-patching@vger.kernel.org
> +Description:
> +		A writable attribute that indicates whether the patched
> +		code is currently applied.  Writing 0 will disable the patch
> +		while writing 1 will re-enable the patch.
> +
> +What:		/sys/kernel/livepatch/<patch>/<object>
> +Date:		Nov 2014
> +KernelVersion:	3.19.0
> +Contact:	live-patching@vger.kernel.org
> +Description:
> +		The object directory contains subdirectories for each function
> +		that is patched within the object.
> +
> +What:		/sys/kernel/livepatch/<patch>/<object>/<function>
> +Date:		Nov 2014
> +KernelVersion:	3.19.0
> +Contact:	live-patching@vger.kernel.org
> +Description:
> +		The function directory contains attributes regarding the
> +		properties and state of the patched function.
> +
> +		There are currently no such attributes.
> diff --git a/MAINTAINERS b/MAINTAINERS
> index c7f49ae..7985293 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -5725,6 +5725,7 @@ F:	kernel/livepatch/
>  F:	include/linux/livepatch.h
>  F:	arch/x86/include/asm/livepatch.h
>  F:	arch/x86/kernel/livepatch.c
> +F:	Documentation/ABI/testing/sysfs-kernel-livepatch
>  L:	live-patching@vger.kernel.org
>  
>  LLC (802.2)
> 


-- 
Masami HIRAMATSU
Software Platform Research Dept. Linux Technology Research Center
Hitachi, Ltd., Yokohama Research Laboratory
E-mail: masami.hiramatsu.pt@hitachi.com