diff mbox series

[v2] mmc-utils: Documentation: Add missing entry for "writeprotect user get" command

Message ID 20250210063947.3298-1-avri.altman@wdc.com
State New
Headers show
Series [v2] mmc-utils: Documentation: Add missing entry for "writeprotect user get" command | expand

Commit Message

Avri Altman Feb. 10, 2025, 6:39 a.m. UTC
This commit adds missing documentation for the "writeprotect user get"
command to both the man page (mmc.1) and the documentation page
(docs/HOWTO.rst).

The "writeprotect user get" command prints the user areas write protect
configuration for the specified device.

Signed-off-by: Avri Altman <avri.altman@wdc.com>

---
Changes in v2:
 - Fix a typo (Christian)
---
 docs/HOWTO.rst | 3 +++
 mmc.1          | 3 +++
 2 files changed, 6 insertions(+)

Comments

Avri Altman March 2, 2025, 7:28 a.m. UTC | #1
Ping.

Thanks,
Avri

> This commit adds missing documentation for the "writeprotect user get"
> command to both the man page (mmc.1) and the documentation page
> (docs/HOWTO.rst).
> 
> The "writeprotect user get" command prints the user areas write protect
> configuration for the specified device.
> 
> Signed-off-by: Avri Altman <avri.altman@wdc.com>
> 
> ---
> Changes in v2:
>  - Fix a typo (Christian)
> ---
>  docs/HOWTO.rst | 3 +++
>  mmc.1          | 3 +++
>  2 files changed, 6 insertions(+)
> 
> diff --git a/docs/HOWTO.rst b/docs/HOWTO.rst
> index 095a9bd..3902fa4 100644
> --- a/docs/HOWTO.rst
> +++ b/docs/HOWTO.rst
> @@ -28,6 +28,9 @@ Running mmc-utils
>          If <number> is passed (0 or 1), only protect that particular eMMC boot
> partition, otherwise protect both. It will be write-protected until the next
> boot.
>          -p  Protect partition permanently instead. NOTE! -p is a one-time
> programmable (unreversible) change.
> 
> +    ``writeprotect user get <device>``
> +        Print the user areas write protect configuration for <device>.
> +
>      ``writeprotect user set <type> <start block> <blocks> <device>``
>          Set user area write protection.
> 
> diff --git a/mmc.1 b/mmc.1
> index 543742c..2f7209c 100644
> --- a/mmc.1
> +++ b/mmc.1
> @@ -27,6 +27,9 @@ If \fInumber\fR is passed (0 or 1), only protect that
> specified eMMC boot partit
>  .br
>  It will be write-protected until the next boot.
>  .TP
> +.BI writeprotect " " user " " get " " \fIdevice\fR
> +Print the user areas write protect configuration for <device>.
> +.TP
>  .BI writeprotect " " user " " set " " \fItype\fR " " \fIstart\-block\fR " "
> \fIblocks\fR " " \fIdevice\fR
>  Set the write protect configuration for the specified region of the user area for
> the device.
>  .br
> --
> 2.25.1
Avri Altman March 9, 2025, 6:39 a.m. UTC | #2
> Ping.
And a second one.

Thanks,
Avri

> 
> Thanks,
> Avri
> 
> > This commit adds missing documentation for the "writeprotect user get"
> > command to both the man page (mmc.1) and the documentation page
> > (docs/HOWTO.rst).
> >
> > The "writeprotect user get" command prints the user areas write
> > protect configuration for the specified device.
> >
> > Signed-off-by: Avri Altman <avri.altman@wdc.com>
> >
> > ---
> > Changes in v2:
> >  - Fix a typo (Christian)
> > ---
> >  docs/HOWTO.rst | 3 +++
> >  mmc.1          | 3 +++
> >  2 files changed, 6 insertions(+)
> >
> > diff --git a/docs/HOWTO.rst b/docs/HOWTO.rst index 095a9bd..3902fa4
> > 100644
> > --- a/docs/HOWTO.rst
> > +++ b/docs/HOWTO.rst
> > @@ -28,6 +28,9 @@ Running mmc-utils
> >          If <number> is passed (0 or 1), only protect that particular
> > eMMC boot partition, otherwise protect both. It will be
> > write-protected until the next boot.
> >          -p  Protect partition permanently instead. NOTE! -p is a
> > one-time programmable (unreversible) change.
> >
> > +    ``writeprotect user get <device>``
> > +        Print the user areas write protect configuration for <device>.
> > +
> >      ``writeprotect user set <type> <start block> <blocks> <device>``
> >          Set user area write protection.
> >
> > diff --git a/mmc.1 b/mmc.1
> > index 543742c..2f7209c 100644
> > --- a/mmc.1
> > +++ b/mmc.1
> > @@ -27,6 +27,9 @@ If \fInumber\fR is passed (0 or 1), only protect
> > that specified eMMC boot partit  .br  It will be write-protected until
> > the next boot.
> >  .TP
> > +.BI writeprotect " " user " " get " " \fIdevice\fR Print the user
> > +areas write protect configuration for <device>.
> > +.TP
> >  .BI writeprotect " " user " " set " " \fItype\fR " " \fIstart\-block\fR " "
> > \fIblocks\fR " " \fIdevice\fR
> >  Set the write protect configuration for the specified region of the
> > user area for the device.
> >  .br
> > --
> > 2.25.1
Ulf Hansson March 12, 2025, 11:41 a.m. UTC | #3
On Mon, 10 Feb 2025 at 07:42, Avri Altman <avri.altman@wdc.com> wrote:
>
> This commit adds missing documentation for the "writeprotect user get"
> command to both the man page (mmc.1) and the documentation page
> (docs/HOWTO.rst).
>
> The "writeprotect user get" command prints the user areas write protect
> configuration for the specified device.
>
> Signed-off-by: Avri Altman <avri.altman@wdc.com>

Applied to mmc-utils, thanks!

Kind regards
Uffe


>
> ---
> Changes in v2:
>  - Fix a typo (Christian)
> ---
>  docs/HOWTO.rst | 3 +++
>  mmc.1          | 3 +++
>  2 files changed, 6 insertions(+)
>
> diff --git a/docs/HOWTO.rst b/docs/HOWTO.rst
> index 095a9bd..3902fa4 100644
> --- a/docs/HOWTO.rst
> +++ b/docs/HOWTO.rst
> @@ -28,6 +28,9 @@ Running mmc-utils
>          If <number> is passed (0 or 1), only protect that particular eMMC boot partition, otherwise protect both. It will be write-protected until the next boot.
>          -p  Protect partition permanently instead. NOTE! -p is a one-time programmable (unreversible) change.
>
> +    ``writeprotect user get <device>``
> +        Print the user areas write protect configuration for <device>.
> +
>      ``writeprotect user set <type> <start block> <blocks> <device>``
>          Set user area write protection.
>
> diff --git a/mmc.1 b/mmc.1
> index 543742c..2f7209c 100644
> --- a/mmc.1
> +++ b/mmc.1
> @@ -27,6 +27,9 @@ If \fInumber\fR is passed (0 or 1), only protect that specified eMMC boot partit
>  .br
>  It will be write-protected until the next boot.
>  .TP
> +.BI writeprotect " " user " " get " " \fIdevice\fR
> +Print the user areas write protect configuration for <device>.
> +.TP
>  .BI writeprotect " " user " " set " " \fItype\fR " " \fIstart\-block\fR " " \fIblocks\fR " " \fIdevice\fR
>  Set the write protect configuration for the specified region of the user area for the device.
>  .br
> --
> 2.25.1
>
diff mbox series

Patch

diff --git a/docs/HOWTO.rst b/docs/HOWTO.rst
index 095a9bd..3902fa4 100644
--- a/docs/HOWTO.rst
+++ b/docs/HOWTO.rst
@@ -28,6 +28,9 @@  Running mmc-utils
         If <number> is passed (0 or 1), only protect that particular eMMC boot partition, otherwise protect both. It will be write-protected until the next boot.
         -p  Protect partition permanently instead. NOTE! -p is a one-time programmable (unreversible) change.
 
+    ``writeprotect user get <device>``
+        Print the user areas write protect configuration for <device>.
+
     ``writeprotect user set <type> <start block> <blocks> <device>``
         Set user area write protection.
 
diff --git a/mmc.1 b/mmc.1
index 543742c..2f7209c 100644
--- a/mmc.1
+++ b/mmc.1
@@ -27,6 +27,9 @@  If \fInumber\fR is passed (0 or 1), only protect that specified eMMC boot partit
 .br
 It will be write-protected until the next boot.
 .TP
+.BI writeprotect " " user " " get " " \fIdevice\fR
+Print the user areas write protect configuration for <device>.
+.TP
 .BI writeprotect " " user " " set " " \fItype\fR " " \fIstart\-block\fR " " \fIblocks\fR " " \fIdevice\fR
 Set the write protect configuration for the specified region of the user area for the device.
 .br