r6433 - in trunk/BOOK: . general/sysutils introduction/welcome

Randy McMurchy randy at linuxfromscratch.org
Fri Jan 19 08:55:14 PST 2007


alexander at linuxfromscratch.org wrote these words on 01/19/07 10:05 CST:
> Author: alexander
> Date: 2007-01-19 09:05:59 -0700 (Fri, 19 Jan 2007)
> New Revision: 6433

Nitpicks follow, disregard if you want. :-)


> +    <bridgehead renderas="sect3">Do I Need the Debian Patch?</bridgehead>
> +    <para>Midnight Commander without the Debian patch is completely unusable
> +    in multibyte locales because it assumes that characters and
> +    bytes are the same thing. The issue manifests itself as massive screen
> +    contents corruption similar to what is depicted in

I'm thinking it should be 'content corruption' (drop the 's')


> +    <ulink url="&files-anduin;/mc-bad.png">this screenshot</ulink>
> +    (taken in the ru_RU.UTF-8 locale). For a general discussion of this type
> +    of issues,

It should be 'this type of issue' or 'these types of issues', you pick.


> +    <para>Fix incompatibility of MC-&mc-version; with Bash-3.2:</para>
> +<screen><userinput>patch -Np1 -i ../mc-&mc-version;-bash32-1.patch</userinput></screen>
> +
> +    <para>If desired, apply Debian fixes:</para>
> +<screen><userinput>patch -Np1 -i ../mc-&mc-version;-debian_fixes-1.patch</userinput></screen>
> +

Typically for readability of the source only, we put a blank line
between the <para>s and the <screen>s


> +            --enable-charset &&
> +make
> +</userinput></screen>

This will put an undesireable blank line in the gray command
section at the end of the commands. Perhaps 'make'</user...


> +    <para>MC with Debian patches expects its documentation to be stored in the
> +    UTF-8 encoding on disk,

Perhaps drop the 'the' before UTF-8?


>      and automatically converts it to the locale
> +    encoding when displaying on the terminal. This is different from the
> +    expectations of the unpatched MC, so the documentation files have to be
> +    converted if (and only if) the Debian patch has been applied:</para>
> +<screen><userinput>convert-mans ISO-8859-1 UTF-8 lib/mc.hint{,.es,.it,.nl} &&

Again, ditto about the blank line (readability only)


> +    <para><parameter>--enable-charset</parameter>: This option adds support
> +    to <command>mcedit</command> for editing files in encodings different from the one implied

Please try to keep line lengths to 80 chars or less (sometimes impossible)


> +    <para><parameter>--with-codepagedir=DIR</parameter>: This parameter was useful
> +    only with SAMBA-2.x. New versions of SAMBA do not have codepage files.</para>

BLFS wraps package names (SAMBA) in <application> tags.


> +    <para><command>chmod 1755 /usr/lib/mc/cons.saver</command>: The
> +    <command>cons.saver</command> program on LFS has to be installed setuid root,

System user names should be wrapped in <systemitem class='username'> tags


> +    because on LFS regular users have no access to <filename>/dev/vcsa*</filename>
> +    devices. This step is optional if MC is going to be started from X terminal

Note that all instances of MC would normally wrapped in <application> tags.


> +    emulators or ssh 

ssh is a command so <command> tags would be in order


>      sessions only (thus rendering the <command>cons.saver</command>
> +    binary completely unneeded).</para>
> +
> +    <!-- Other distributions make the devices owned by the vcsa group

Again, a <systemitem> tag (class='group')


> +         and make the cons.saver program setgid vcsa instead -->

For consistency, need a <command> tag (as in the previous instance
of cons.saver.


> +      <varlistentry id="conssaver">
> +        <term><command>cons.saver</command></term>
> +        <listitem>
> +          <para>is used internally by <command>mc</command> for saving and
> +	  restoring the text behind the panels on Linux text console.</para>

Not sure if the misalignment is due to tabs or just not enough spaces.


> +      <varlistentry id="mcmfmt">
> +        <term><command>mcmfmt</command></term>
> +        <listitem>
> +          <para>is used internally by <command>mcview</command> when viewing mailbox files.</para>

Line length (this is only me, normally everyone else thinks it okay. I
just like to keep <80 so printed listings don't wrap strangely or
become truncated, or if someone is using a text console to edit).


>      <listitem>
> +      <para>January 19th, 2007</para>
> +      <itemizedlist>
> +        <listitem>
> +          <para>[alexander] - Added Debian patch and bash-3.2
> +	  compatibility patch to MC. Fixes #2189.</para>

Again, misalignment (Manuel has requested *no* tabs to be used in the XML).

Overall, an excellent commit to the package, Alexander. Please don't
take my comments as criticism.

-- 
Randy

rmlscsi: [bogomips 1003.26] [GNU ld version 2.16.1] [gcc (GCC) 4.0.3]
[GNU C Library stable release version 2.3.6] [Linux 2.6.14.3 i686]
10:30:00 up 9 days, 10:44, 1 user, load average: 0.06, 0.04, 0.01



More information about the blfs-book mailing list