[arch-releng] [PATCH 4/5] releng: clarify some text and options

[Dieter Plaetinck]

On Mon, 2 May 2011 10:48:17 -0500
Dan McGee <dpmcgee at gmail.com> wrote:

> On Sun, May 1, 2011 at 5:38 AM, Dieter Plaetinck <dieter at plaetinck.be> wrote:
> >
> > Signed-off-by: Dieter Plaetinck <dieter at plaetinck.be>
> > ---
> >  releng/fixtures/installtype.json |    3 ++-
> >  releng/views.py                  |    6 ++++--
> >  templates/releng/add.html        |   15 +++++++++++----
> >  3 files changed, 17 insertions(+), 7 deletions(-)
> >
> > diff --git a/releng/fixtures/installtype.json b/releng/fixtures/installtype.json
> > index 7fa21fc..d23aa33 100644
> > --- a/releng/fixtures/installtype.json
> > +++ b/releng/fixtures/installtype.json
> > @@ -24,7 +24,8 @@
> >        "pk": 4,
> >        "model": "releng.installtype",
> >        "fields": {
> > -           "name": "automatic install custom config (specify in comments)"
> > +           "name": "automatic install custom config (if special, specify in comments)"
> >        }
> >     }
> >  ]
> > diff --git a/releng/views.py b/releng/views.py
> > index f23869f..71a5e68 100644
> > --- a/releng/views.py
> > +++ b/releng/views.py
> > @@ -23,10 +23,12 @@ class TestForm(forms.ModelForm):
> >     source = standard_field(Source)
> >     clock_choice = standard_field(ClockChoice)
> >     filesystem = standard_field(Filesystem,
> > -            help_text="Check the installed system, including fstab.")
> > +            help_text="Check the installed system with something like 'df -hT'" \
> > +            ", lvdisplay (for lvm), etc.  Also check fstab.")
> Why are we saying more than we have to with things like "check the
> installed system?" If you're giving feedback it is assumed to be about
> the installed system. Even the new instructions tell a command to run
> but not a takeaway.
> 
> Why not just something like "Block and filesystem modules in use?" or something?

Hmm, I just want to make sure people submitting feedback properly check (or rather: 'verify', the word 'check' is confusing here as you mention below) the newly installed system.
but you're right, I should only mention that once.  The top of templates/releng/add.html is more suited. 
but nonetheless I think your suggestion is not enough.
How about: "verify /etc/fstab, `df -hT` output and commands like lvdisplay for special modules"


> 
> >     modules = forms.ModelMultipleChoiceField(queryset=Module.objects.all(),
> >             help_text="", widget=forms.CheckboxSelectMultiple(), required=False)
> > -    bootloader = standard_field(Bootloader)
> > +    bootloader = standard_field(Bootloader,
> > +            help_text="Check the configuration of the bootloader")
> This seems to add no clarification to me. "Check" in the "check the
> checkbox" (except it is a radio button) sense? "Check" in the "take a
> look at it and make sure things are right" sense? In which case I
> don't even know what I'm looking for.

the latter. how about:
"Verify that the entries in the bootloader config look ok"

> 
> >     rollback_filesystem = standard_field(Filesystem,
> >             help_text="If you did a rollback followed by a new attempt to setup " \
> >             "your lockdevices/filesystems, select which option you took here.",
> > diff --git a/templates/releng/add.html b/templates/releng/add.html
> > index 3678532..9be5f4c 100644
> > --- a/templates/releng/add.html
> > +++ b/templates/releng/add.html
> > @@ -6,10 +6,17 @@
> >  <div class="box">
> >     <h2>Arch Releng Testbuild Feedback Entry</h2>
> >
> > -    <p>This page allows you to submit feedback after testing and using a
> > -    release engineering install ISO. If you do not currently have feedback to
> > -    submit, you may want to take a look at the current
> > -    <a href="{% url releng-test-overview %}">results page</a>.</p>
> > +    <p>This page allows you to submit feedback after testing an Arch Linux installation
> > +    using a release engineering testbuild.  Mark all the options you used during the
> > +    installation; at the end you can specify whether everything went OK.  Be
> > +    sure to only denote a successfull install after having checked the
> successful
> > +    installation properly.  Some options require you to check several things (such as
> > +    config files), this will be mentioned alongside the option.</p>
> > +    <p>There is also an overview of all feedback on the
> > +    <a href="{% url releng-test-overview %}">results page</a>.  Once we have
> > +    builds that are properly tested (enough successfull feedback for all
> successful
> > +    important features of the iso or a slightly earlier iso), we can release new
> Please use "ISO".
> > +    official media.</p>
> >
> >     <div id="releng-feedback"> <form action="" method="post">{% csrf_token %}
> >             {{ form.as_p }}
> > --
> > 1.7.4.4
> >
> >

will do, after you replied, I'll make a new patch.

Dieter