Re: Typo

[Laurent Lyaudet]

Hello,

Le sam. 1 juil. 2023 à 15:22, Laurent Lyaudet
<laurent.lyaudet@gmail.com> a écrit :
> Anyway here are my attempts at both problems:
> patch 1
> From c2311dd3d6b6f22467565f7331cdf088eb8d9103 Mon Sep 17 00:00:00 2001
> From: Laurent Lyaudet <laurent.lyaudet@gmail.com>
> Date: Sat, 1 Jul 2023 15:06:03 +0200
> Subject: [PATCH] LL : correction typo "the same size as the number" is O(lg
>  number) but "the same as the number" is O(number) :)
>
> ---
>  doc/gperf.texi | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/doc/gperf.texi b/doc/gperf.texi
> index 0ab43c0..5900db9 100644
> --- a/doc/gperf.texi
> +++ b/doc/gperf.texi
> @@ -1338,7 +1338,7 @@ table should decrease the time required for an
> unsuccessful search, at
>  the expense of extra table space.
>
>  The default value is 1, thus the default maximum associated value is about
> -the same size as the number of keywords.  (For efficiency, the maximum
> +the same as the number of keywords.  (For efficiency, the maximum
>  associated value is always rounded up to a power of 2.)  The actual
>  table size may vary somewhat, since this technique is essentially a
>  heuristic.
> --
> 2.39.2
>
> patch 2
> From 5bc80d9fdc40e5aa66b4292445566b2699d6d679 Mon Sep 17 00:00:00 2001
> From: Laurent Lyaudet <laurent.lyaudet@gmail.com>
> Date: Sat, 1 Jul 2023 15:18:20 +0200
> Subject: [PATCH] LL: attempt at a CONTRIBUTING file to help anyone who does
>  not not know where to start.
>
> ---
>  CONTRIBUTING | 15 +++++++++++++++
>  1 file changed, 15 insertions(+)
>  create mode 100644 CONTRIBUTING
>
> diff --git a/CONTRIBUTING b/CONTRIBUTING
> new file mode 100644
> index 0000000..46fc4bd
> --- /dev/null
> +++ b/CONTRIBUTING
> @@ -0,0 +1,15 @@
> +If you want to contribute a patch,
> +please modify the code as you think it should be.
> +Then commit your changes in one or more commits.
> +Then send the result of the following command,
> +for example, if there is only one commit:
> +git format-patch -1 <commit-sha1>
> +
> +For more complex cases, see:
> +https://git-scm.com/docs/git-diff
> +https://git-scm.com/docs/git-format-patch
> +https://git-scm.com/docs/git-am
> +
> +Then send your patch by email at bug-gperf@gnu.org
> +Thanks :)
> +
> --
> 2.39.2
I was expecting an answer.
I have reread my two patches searching for hints that something may be
really wrong.
So far, I have seen that the comment of the first patch is not correct,
but the existing sentence does not look good to me either.
This sentence does not imply O(lg n) as I wrote by error:
>  The default value is 1, thus the default maximum associated value is about
> -the same size as the number of keywords.
I wrongly misunderstood it to be
"the default maximum associated value is about the same as the size of
the number of keywords".
However, I believe that
"the default maximum associated value *has* about the same size as the
number of keywords"
would be more correct.
Since I'm not a native English speaker, I cannot tell with certainty.

Regarding the second patch, I was expecting that my wording and the
light-process contribution spirit could be a problem
if you prefer that things are discussed in the mailing list or IRC
before people send actual patches.
But I was hoping that you would think it is a good idea to have a
CONTRIBUTING file which explains
what is known by some people but not all people.
My third PhD advisor teached me that the right level of redundancy is not zero,
in a book, in an article, in a speech.
It would be good for free-software that some "welcoming-sugar"
analogous to syntactic-sugar
is present in free repositories.
The file README does not do that.
The file JOIN-GNU is overly broad and unspecific, telling people to
join and look at other resources.
A file CONTRIBUTING for people that just want to help for this
repository would be great.
Otherwise, if the goal is to have all people wanting to contribute to
gperf to "join GNU" first,
then the file JOIN-GNU should be customized to tell this is the actual
and only process to contribute :).

Best regards,
     Laurent Lyaudet