[RFC] Add ARI directory to gdb sources

[RFC] Add ARI directory to gdb sources

[Pierre Muller]

  We recently had a discussion about integrating gdb_ari.sh script
into gdb sources directly.

See:
http://sourceware.org/ml/gdb-patches/2012-04/msg00834.html

  Currently the ARI (Awk Regression Index)
script is a separate cvs checkout
and is used to generate three type of ARI reports:

Last release ARI:
http://sourceware.org/gdb/download/ari/
generated normally in the release process.

daily run for current cvs trunk:
http://sourceware.org/gdb/current/ari/

daily run for most recent branch:
http://sourceware.org/gdb/ari/

  The idea behind moving gdb_ari.sh script into gdb sources 
would be:
1) Be able to adapt this script to changes in the gdb sources.
  Example: Currently, there are 14 types of critical bugs
(corresponding to previously eliminated problems that resurfaced).
These are mostly due to some functions that should not generally
be used in the gdb sources (like xasprintf function)
but are present at specific locations:

BEGIN { doc["xasprintf"] = "\
Do not use xasprintf(), instead use xstrprintf"
    fix("xasprintf", "gdb/defs.h", 1)
    fix("xasprintf", "gdb/utils.c", 1)
    category["xasprintf"] = ari_regression
}
/(^|[^_[:alnum:]])xasprintf[[:space:]]*\(/ {
    fail("xasprintf")
}

This means that xasprintf function should appear
only two type in the whole gdb sources,
once in defs.gh and once in utils.c.
  But recent changes (moves of some functions to common
subdirectory), lead to the fact that xasprintf is now
referenced in common/common-utils.h and common/common-utils.c

  This is of course not a real problem, but changing this
in the gdb_ari.sh script would mean that this script would
give wrong information if run on older gdb sources.

2) The second reason was to allow developers or any person
that wants to analyze gdb sources to run this script.


  The question of the location where we should add this script in gdb source
arose.
Joel suggested to put it directly into
gdb directory.
  But after looking at the suggestion, it appears
that you can't just use gdb_ari.sh alone,
the update-web-ari script also uses gdb_find.sh script for instance,
and a modified version of this update-web-air should probably also
be added.

  Thus I would rather suggest to add a new directory called ari.

Suggestions and comments most welcomed,



Pierre Muller
GDB pascal language maintainer
writing as unofficial ARI maitainer

Re: [RFC] Add ARI directory to gdb sources

[Joel Brobecker]

>   The question of the location where we should add this script in gdb
>   source arose.  Joel suggested to put it directly into gdb directory.

Yeah, I didn't say it, but I agree it was a poor suggestion,
especially in light of:

>   But after looking at the suggestion, it appears that you can't just
>   use gdb_ari.sh alone, the update-web-ari script also uses
>   gdb_find.sh script for instance, and a modified version of this
>   update-web-air should probably also be added.

Here's what I think: Everything that generates is required to generate
the HTML code should be moved to the GDB directory. gdb/ari/ seems
fine to me, but others might want to comment. Unless the location
is critical to the implementation, which I hope it won't be, you
can start working on the move and submit patches. It should be
relatively easy to change the names if other suggestions appear.

On a user-interface level, it would be nice if the script that generates
the HTML was callable from out of tree, a little like configure.
I could create the HTML is a directory called "ari" located in
the current directory, for instance...

> writing as unofficial ARI maitainer

As far as I am concerned, you are the official ARI Maintainer :).
We'll make that official-official as soon as the code is moved
to the GDB repository by adding a section in the MAINTAINERS file.

-- 
Joel

Re: [RFC] Add ARI directory to gdb sources

[Sergio Durigan Junior]

On Wednesday, May 16 2012, Joel Brobecker wrote:

>>   But after looking at the suggestion, it appears that you can't just
>>   use gdb_ari.sh alone, the update-web-ari script also uses
>>   gdb_find.sh script for instance, and a modified version of this
>>   update-web-air should probably also be added.
>
> Here's what I think: Everything that generates is required to generate
> the HTML code should be moved to the GDB directory. gdb/ari/ seems
> fine to me, but others might want to comment. Unless the location
> is critical to the implementation, which I hope it won't be, you
> can start working on the move and submit patches. It should be
> relatively easy to change the names if other suggestions appear.

Pierre showed up in IRC and mentioned that someone suggested
`gdb/contrib'.  I could not find the thread/message, but I support this
idea FWIW.  `gdb/contrib/ari' would be good, then.

My rationale is that ARI is not part of GDB as a program nor distributed
with it, so creating `gdb/ari' would perhaps confuse people because
there are other directories there like `gdb/mi' or `gdb/cli'.

My 2 cents.

-- 
Sergio

Re: [RFC] Add ARI directory to gdb sources

[Joel Brobecker]

> Pierre showed up in IRC and mentioned that someone suggested
> `gdb/contrib'.  I could not find the thread/message, but I support this
> idea FWIW.  `gdb/contrib/ari' would be good, then.
> 
> My rationale is that ARI is not part of GDB as a program nor distributed
> with it, so creating `gdb/ari' would perhaps confuse people because
> there are other directories there like `gdb/mi' or `gdb/cli'.

That was Doug Evans.

I have no issues with contrib/ari, and I kind of like it better too.
I do feel the need to correct that the new scripts will be part of GDB,
and thus will be distributed with it as well.

-- 
Joel

Re: [RFC] Add ARI directory to gdb sources

[Sergio Durigan Junior]

On Friday, May 18 2012, Joel Brobecker wrote:

> I have no issues with contrib/ari, and I kind of like it better too.
> I do feel the need to correct that the new scripts will be part of GDB,
> and thus will be distributed with it as well.

Duh.  Thank you for this correction, now that I've come to think of it,
it makes total sense.

So, Pierre, does that answer the question?  I guess you're free to go
with `gdb/contrib/ari', then.

Regards,


-- 
Sergio

Re: [RFC] Add ARI directory to gdb sources

[Tom Tromey]

>>>>> "Pierre" == Pierre Muller <pierre.muller@ics-cnrs.unistra.fr> writes:

Pierre>   Thus I would rather suggest to add a new directory called ari.

That would be fine by me.

Tom