[prev in list] [next in list] [prev in thread] [next in thread] 

List:       openbsd-tech
Subject:    Re: Harmonize examples in signify man page
From:       Jason McIntyre <jmc () kerhand ! co ! uk>
Date:       2019-02-28 14:46:20
Message-ID: 20190228144620.GB83171 () harkle
[Download RAW message or body]

On Mon, Feb 25, 2019 at 10:00:59PM +0100, Marc Espie wrote:
> On Sun, Feb 24, 2019 at 10:09:43PM +0100, Matthias Schmidt wrote:
> > Hi,
> > 
> > while looking at signify's man page I noticed that the names of the
> > arguments in the EXAMPLES section change (newkey.sec vs key.sec, etc).
> > The diff harmonizes the examples.  It makes it easier to follow the examples. 
> > 
> > Cheers
> > 
> > 	Matthias
> > 
> >  diff --git signify.1 signify.1
> >  index de3b433e3b0..9f7335352a2 100644
> >  --- signify.1
> >  +++ signify.1
> >  @@ -153,13 +153,13 @@ The message file is too large.
> >   .El
> >   .Sh EXAMPLES
> >   Create a new key pair:
> >  -.Dl $ signify -G -p newkey.pub -s newkey.sec
> >  +.Dl $ signify -G -p key.pub -s key.sec
> >   .Pp
> >   Sign a file, specifying a signature name:
> >  -.Dl $ signify -S -s key.sec -m message.txt -x msg.sig
> >  +.Dl $ signify -S -s key.sec -m message -x message.sig
> 
> Your mileage may vary, but this makes things harder to follow for me.
> 
> Obviously visually differentiating between creating new keys and using
> existing ones makes a lot of sense for me.
> 
> Especially since the examples are not meant to be chained together, at
> all.  This is a reference manual, not a tutorial.
> 

hi.

the reception to this diff wasn;t great, so i'm personally going to
considered it dropped, unless any developeras push for changes in this
area.

jmc

[prev in list] [next in list] [prev in thread] [next in thread]