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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



> On 2/6/25 08:38, Avri Altman 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@xxxxxxx>
> > ---
> >  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..7e94557 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
> > +.B writeprotect user get <device>
> 
> Should be BI for consistency I guess.
Done.

> 
> > +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
> 
> Somewhat a nuisance to have to maintain and sync all of
> docs/HOWTO.rst
This is for https://mmc-utils.readthedocs.io/en/latest/
Got complaints from field application engineers that such page is missing.

Thanks,
Avri

> mmc.1
> mmc.c
> for these simple commands.
> Anyway with the minor nit:
> Reviewed-by: Christian Loehle <christian.loehle@xxxxxxx>





[Index of Archives]     [Linux Memonry Technology]     [Linux USB Devel]     [Linux Media]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux