[schilytools] that blody endanness-issue again

[Robert Clausecker]

Hi Friedhelm,

> The problem we have at the moment, is that the spelling is not
> consistent througout the source and the documentation. Three different
> spellings are used. This is not good, as i.e. calling a program with the
> help-option gives another spelling as the manual page.
> 
> You have to decide one way or the other.

Nope, I don't.  Spelling doesn't have to be consistent throughout the
project.  As long as there are no typos, it doesn't matter if different
parts of the project spell words in documentation etc. differently.

What would be a problem is if an option was spelled differently in the
program and the documentation such that using the option as given in the
documentation doesn't work (or such that the option in the program cannot
be found in the documentation, or similar).

For options in particular, it may be acceptable depending on the use case
to support multiple spellings for the same option as to make the program
more user friendly.  However, such changes must be weighed carefully as we
can never remove options once they have been added.

> May I suggest, that to fix this once and for all, you do something like
> this:
> 
>    find . -type f -exec sed -i 's/endianes/endianess/g' {} +
>    find . -type f -exec sed -i 's/Endianes/Endianess/g' {} +
>    find . -type f -exec sed -i 's/ENDIANES/ENDIANESS/g' {} +
>    find . -type f -exec sed -i 's/endianness/endianess/g' {} +
>    find . -type f -exec sed -i 's/Endianness/Endianess/g' {} +
>    find . -type f -exec sed -i 's/ENDIANNESS/ENDIANESS/g' {} +
> 
>    git restore ANNOUNCEMENTS/*
>    git restore AN-*
>    git restore <your-license-text>

Licenses can be part of other files.  There can also be other strings
matching the patterns you do not want to replace.  Do not ever blindly
search and replace spelling like that.  All such changes must be manually
checked for correctness.  I assume you do so before submitting patches.

>    git commit -m 'Fix the damn endianess-issue once and for all'
> 
> I accidently corrected some spellings that have not been wrong. I simply
> used aspell and the directory, that comes with it, to find errors.  I'm
> sorry, if that causes some confusion and additional work for you.

While I apreciate your help, please always copy read the changes before
submitting them.  Each time you have to redo the change set because you
didn't review the changes before you submitted them, I have to review the
whole thing again.  That's not a productive use of my time, especially when
100+ files are affected.

Also, please note that it's not a goal of this project to make aspell happy.
Spell checkers are utilities that give you suggestions for spellings.  These
suggestions have to be ignored if they are wrong.  They are not divide words
that must be followed under all circumstances.

> Unfortunately Jörg wrote a lot of documentation and there are a lot of
> typos as well...

Sure, I agree with that.  Lots of awkward grammar, too.  Always happy to see
that improved, as long as the original was actually wrong (and not just
different).

> Best Regards
> Friedhelm

Yours,
Robert Clausecker

-- 
()  ascii ribbon campaign - for an 8-bit clean world 
/\  - against html email  - against proprietary attachments