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

Re: buster and the release notes



Niels Thykier wrote:
>> How about upgrading.dbk and whatsnew.dbk?
> 
> Hi,
> 
> The "upgrading.dbk" historically had release-specific content "hidden"
> deeply within selected sections.  In stretch we took an effort to
> extract that to "issues.dbk" so the "routined" administrator would only
> have to read "issues.dbk" for potential problems.
> 
> IOW: upgrading.dbk should be in a state where we can close it (assuming
> we got all the release specific issues moved to issues - I do not
> remember and I did not have time to check).

If the content's settled, now would be a good time to review the
English.  Issues in issues.dbk:

diff --git a/en/issues.dbk b/en/issues.dbk
index 8ddb32d3..69054251 100644
--- a/en/issues.dbk
+++ b/en/issues.dbk
@@ -76,7 +76,7 @@ information mentioned in <xref linkend="morereading"/>.

In "deprecated-components":

         <listitem>
           <para>
             The package <systemitem
	     role="package">mcelog</systemitem> is no
-            longer supported in kernels above 4.12. <systemitem

Drivers might be "in" a kernel, but packages are usually "under" it!
As a compromise:

+            longer supported with kernel versions above 4.12. <systemitem
             role="package">rasdaemon</systemitem> can be used as its
             replacement.
           </para>
@@ -126,7 +126,7 @@ information mentioned in <xref linkend="morereading"/>.

Still in "deprecated-components":

       </listitem>
       <listitem>
         <para>
-          Icinga 1.x is EOL upstream since 2018-12-31, while the
+          Icinga 1.x is EOL upstream since 2018-12-31; while the

I would have said something like "has reached EOL", but Google tells
me plenty of people say "is EOL", so I'll just fix the comma-splice.

           <systemitem role="package">icinga</systemitem> package
-          is still present, users should use the buster lifetime
+          is still available, users should use the buster lifetime

On second thoughts this isn't really necessary, so I'll take it out of
the attached version of the patch.

           to migrate to Icinga 2
           (<systemitem role="package">icinga2</systemitem> package)
           and Icinga Web 2

@@ -200,7 +200,7 @@ information mentioned in <xref linkend="morereading"/>.

Under "obsolete-sysvinit-packages":

     <title>SysV init related packages no longer required</title>
     <note>
       <para>
-        This section does not apply if you decided to stick with sysvinit-core.
+        This section does not apply if you have decided to stick with sysvinit-core.
       </para>

A nice demonstration of a subtle aspectual difference.  "I decided" is
just a finished event; "I have decided" means the effects are still
relevant - i.e. I haven't changed my mind again since.

     </note>
     <para>
@@ -238,7 +238,7 @@ information mentioned in <xref linkend="morereading"/>.

Under "browser-security":

       releases. Therefore, browsers built upon e.g. the webkit and khtml
       engines<footnote><para>These engines are shipped in a number of different
       source packages and the concern applies to all packages shipping
-      them. The concern also extends to web rendering engines not explicitely
+      them. The concern also extends to web rendering engines not explicitly

Spelling.  (Also: if we're going to expect users to know that, e.g.,
Konqueror is built on khtml, it would be nice if browsers could be
relied on to mention this sort of thing in their package descriptions.
But that's not a release-notes bug.)

       mentioned here.</para></footnote> are included in &releasename;, but not
       covered by security support. These browsers should not be used against
       untrusted websites.
@@ -309,11 +309,11 @@ information mentioned in <xref linkend="morereading"/>.

Under "su-environment-variables":

     <!-- stretch to buster-->
     <title>Semantics for using environment variables for su changed</title>
     <para>
-      <literal>su</literal> changed semantics in &releasename; and no longer copies

This needs another tense/aspect tweak (because for a start buster
isn't in the past yet).

-      over <literal>DISPLAY</literal> and <literal>XAUTHORITY</literal>

"Copies over X" is unclear - does it copy something over them, or does
it copy them over to somewhere?  Besides, the idea of "copying" is a
bit of an implementation detail; the most that's apparent to the user
is that the variables are no longer set in root's environment.

-      environment variables. You need to explicitly set them and allow
-      explicitly access to your display if you need to run graphical

"Allow explicitly access" is scrambled word order.  But it doesn't
really need to repeat "explicitly" (explicitly).

-      applications with <literal>su</literal>. See <ulink
+      <literal>su</literal> has changed semantics in &releasename; and no longer
+      preserves the user environment variables <literal>DISPLAY</literal> and
+      <literal>XAUTHORITY</literal>. If you need to run graphical applications
+      with <literal>su</literal>, you will have to explicitly set them to allow
+      access to your display. See <ulink

"You need to X and Y if Z" might in principle mean that you always
need to do X, but Y is only necessary if Z.  Putting the if-clause
first avoids this, with the bonus that non-Z readers can finish early.

       url="&url-bts;905409">bug #905409</ulink> for an extensive discussion.
     </para>
   </section>

(Didn't I hear something about problems for users who are running "su"
when they ought to be using "su -"?  Oh, yes, I heard about it from
the NEWS.Debian file, so never mind.)
-- 
JBR	with qualifications in linguistics, experience as a Debian
	sysadmin, and probably no clue about this particular package
diff --git a/en/issues.dbk b/en/issues.dbk
index 8ddb32d3..69054251 100644
--- a/en/issues.dbk
+++ b/en/issues.dbk
@@ -76,7 +76,7 @@ information mentioned in <xref linkend="morereading"/>.
         <listitem>
           <para>
             The package <systemitem role="package">mcelog</systemitem> is no
-            longer supported in kernels above 4.12. <systemitem
+            longer supported with kernel versions above 4.12. <systemitem
             role="package">rasdaemon</systemitem> can be used as its
             replacement.
           </para>
@@ -126,7 +126,7 @@ information mentioned in <xref linkend="morereading"/>.
       </listitem>
       <listitem>
         <para>
-          Icinga 1.x is EOL upstream since 2018-12-31, while the
+          Icinga 1.x is EOL upstream since 2018-12-31; while the
           <systemitem role="package">icinga</systemitem> package
           is still present, users should use the buster lifetime
           to migrate to Icinga 2
@@ -200,7 +200,7 @@ information mentioned in <xref linkend="morereading"/>.
     <title>SysV init related packages no longer required</title>
     <note>
       <para>
-        This section does not apply if you decided to stick with sysvinit-core.
+        This section does not apply if you have decided to stick with sysvinit-core.
       </para>
     </note>
     <para>
@@ -238,7 +238,7 @@ information mentioned in <xref linkend="morereading"/>.
       releases. Therefore, browsers built upon e.g. the webkit and khtml
       engines<footnote><para>These engines are shipped in a number of different
       source packages and the concern applies to all packages shipping
-      them. The concern also extends to web rendering engines not explicitely
+      them. The concern also extends to web rendering engines not explicitly
       mentioned here.</para></footnote> are included in &releasename;, but not
       covered by security support. These browsers should not be used against
       untrusted websites.
@@ -309,11 +309,11 @@ information mentioned in <xref linkend="morereading"/>.
     <!-- stretch to buster-->
     <title>Semantics for using environment variables for su changed</title>
     <para>
-      <literal>su</literal> changed semantics in &releasename; and no longer copies
-      over <literal>DISPLAY</literal> and <literal>XAUTHORITY</literal>
-      environment variables. You need to explicitly set them and allow
-      explicitly access to your display if you need to run graphical
-      applications with <literal>su</literal>. See <ulink
+      <literal>su</literal> has changed semantics in &releasename; and no longer
+      preserves the user environment variables <literal>DISPLAY</literal> and
+      <literal>XAUTHORITY</literal>. If you need to run graphical applications
+      with <literal>su</literal>, you will have to explicitly set them to allow
+      access to your display. See <ulink
       url="&url-bts;905409">bug #905409</ulink> for an extensive discussion.
     </para>
   </section>

Reply to: