Re: [PATCH 24/34] docs: filesystems: convert quota.txt to ReST
From: Jan Kara
Date: Thu Apr 16 2020 - 04:54:55 EST
On Wed 15-04-20 16:32:37, Mauro Carvalho Chehab wrote:
> - Add a SPDX header;
> - Adjust document title;
> - Some whitespace fixes and new line breaks;
> - Add it to filesystems/index.rst.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
Looks good to me. You can add:
Acked-by: Jan Kara <jack@xxxxxxx>
Honza
> ---
> Documentation/filesystems/index.rst | 1 +
> .../filesystems/{quota.txt => quota.rst} | 41 +++++++++++++------
> MAINTAINERS | 2 +-
> 3 files changed, 31 insertions(+), 13 deletions(-)
> rename Documentation/filesystems/{quota.txt => quota.rst} (81%)
>
> diff --git a/Documentation/filesystems/index.rst b/Documentation/filesystems/index.rst
> index a35b7d6ee5bc..8a17f8234b86 100644
> --- a/Documentation/filesystems/index.rst
> +++ b/Documentation/filesystems/index.rst
> @@ -33,6 +33,7 @@ algorithms work.
> locks
> mandatory-locking
> mount_api
> + quota
>
> automount-support
>
> diff --git a/Documentation/filesystems/quota.txt b/Documentation/filesystems/quota.rst
> similarity index 81%
> rename from Documentation/filesystems/quota.txt
> rename to Documentation/filesystems/quota.rst
> index 32874b06ebe9..a30cdd47c652 100644
> --- a/Documentation/filesystems/quota.txt
> +++ b/Documentation/filesystems/quota.rst
> @@ -1,4 +1,6 @@
> +.. SPDX-License-Identifier: GPL-2.0
>
> +===============
> Quota subsystem
> ===============
>
> @@ -39,6 +41,7 @@ Currently, the interface supports only one message type QUOTA_NL_C_WARNING.
> This command is used to send a notification about any of the above mentioned
> events. Each message has six attributes. These are (type of the argument is
> in parentheses):
> +
> QUOTA_NL_A_QTYPE (u32)
> - type of quota being exceeded (one of USRQUOTA, GRPQUOTA)
> QUOTA_NL_A_EXCESS_ID (u64)
> @@ -48,20 +51,34 @@ in parentheses):
> - UID of a user who caused the event
> QUOTA_NL_A_WARNING (u32)
> - what kind of limit is exceeded:
> - QUOTA_NL_IHARDWARN - inode hardlimit
> - QUOTA_NL_ISOFTLONGWARN - inode softlimit is exceeded longer
> - than given grace period
> - QUOTA_NL_ISOFTWARN - inode softlimit
> - QUOTA_NL_BHARDWARN - space (block) hardlimit
> - QUOTA_NL_BSOFTLONGWARN - space (block) softlimit is exceeded
> - longer than given grace period.
> - QUOTA_NL_BSOFTWARN - space (block) softlimit
> +
> + QUOTA_NL_IHARDWARN
> + inode hardlimit
> + QUOTA_NL_ISOFTLONGWARN
> + inode softlimit is exceeded longer
> + than given grace period
> + QUOTA_NL_ISOFTWARN
> + inode softlimit
> + QUOTA_NL_BHARDWARN
> + space (block) hardlimit
> + QUOTA_NL_BSOFTLONGWARN
> + space (block) softlimit is exceeded
> + longer than given grace period.
> + QUOTA_NL_BSOFTWARN
> + space (block) softlimit
> +
> - four warnings are also defined for the event when user stops
> exceeding some limit:
> - QUOTA_NL_IHARDBELOW - inode hardlimit
> - QUOTA_NL_ISOFTBELOW - inode softlimit
> - QUOTA_NL_BHARDBELOW - space (block) hardlimit
> - QUOTA_NL_BSOFTBELOW - space (block) softlimit
> +
> + QUOTA_NL_IHARDBELOW
> + inode hardlimit
> + QUOTA_NL_ISOFTBELOW
> + inode softlimit
> + QUOTA_NL_BHARDBELOW
> + space (block) hardlimit
> + QUOTA_NL_BSOFTBELOW
> + space (block) softlimit
> +
> QUOTA_NL_A_DEV_MAJOR (u32)
> - major number of a device with the affected filesystem
> QUOTA_NL_A_DEV_MINOR (u32)
> diff --git a/MAINTAINERS b/MAINTAINERS
> index 470389ef0135..519f5d84adca 100644
> --- a/MAINTAINERS
> +++ b/MAINTAINERS
> @@ -5009,7 +5009,7 @@ W: http://www.win.tue.nl/~aeb/partitions/partition_types-1.html
> DISKQUOTA
> M: Jan Kara <jack@xxxxxxxx>
> S: Maintained
> -F: Documentation/filesystems/quota.txt
> +F: Documentation/filesystems/quota.rst
> F: fs/quota/
> F: include/linux/quota*.h
> F: include/uapi/linux/quota*.h
> --
> 2.25.2
>
--
Jan Kara <jack@xxxxxxxx>
SUSE Labs, CR