[systemd-devel] [PATCH] man: improve wording of systemctl's --after/--before

[Jason St. John]

On Sat, Mar 15, 2014 at 12:17 AM, Zbigniew Jędrzejewski-Szmek
<zbyszek at in.waw.pl> wrote:
> On Thu, Mar 13, 2014 at 09:03:09AM +0400, Andrey Borzenkov wrote:
> > В Wed, 12 Mar 2014 23:07:32 -0400
> > "Jason St. John" <jstjohn at purdue.edu> пишет:
> >
> > > Commit 4a77ca7 was an attempt at fixing the wording of --after and --before,
> > > but the new wording was unclear.
> > >
> > > Split the combined --after/--before section into a separate section for
> > > each, explicitly state what each option does, and add information about
> > > how these lists are generated.
> > >
> > > Reported-by: Andrey Borzenkov <arvidjaar at gmail.com>
> > > Reported-by: Lennart Poettering <lennart at poettering.net>
> > > ---
> > > Patch that resulted in commit 4a77ca7 was posted here:
> > > http://lists.freedesktop.org/archives/systemd-devel/2014-February/017277.html
> > >
> > > Lennart's response:
> > > http://lists.freedesktop.org/archives/systemd-devel/2014-March/017778.html
> > >
> > > I put a "Reported-by" line for Andrey because he was the one that originally
> > > brought this to the ML's attention, and I added one for Lennart because his
> > > note about the whole section needing rewording is what directed my attention
> > > to this. If "Reported-by" lines are not to be used, feel free to strip them
> > > when applying.
> > >
> > >
> > >  man/systemctl.xml | 17 ++++++++++++++---
> > >  1 file changed, 14 insertions(+), 3 deletions(-)
> > >
> > > diff --git a/man/systemctl.xml b/man/systemctl.xml
> > > index ee6ab8f..a24b7c1 100644
> > > --- a/man/systemctl.xml
> > > +++ b/man/systemctl.xml
> > > @@ -145,12 +145,23 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>.
> > >
> > >        <varlistentry>
> > >          <term><option>--after</option></term>
> > > +
> > > +        <listitem>
> > > +          <para>With <command>list-dependencies</command>, show the
> > > +          units that are ordered before the specified unit. In other
> >
> > Hmm ... so now it is absolutely unclear why it is called "after" in the
> > first place. Because it describes what happens "before"? :) May be,
> > something like
> >
> > In other words, specified unit is ordered after all of listed units.
> >
> > > +          words, list the units that are in the <varname>After=</varname>
> > > +          directive of the specified unit.</para>
> >
> > No, the second sentence is wrong. Other unit may have Before=<specified
> > unit> or it may be implicit dependencies.
> Right. Jason, can you update the patch?
>
> Thanks,
> Zbyszek

I just resubmitted the patch based on the above feedback. It can be found here:
http://lists.freedesktop.org/archives/systemd-devel/2014-March/017939.html

I can resubmit using Andrey's suggested wording above if the new patch
is too wordy or if it isn't as clear as it should be.

Thanks,
Jason