Wiki: Started a page on how to write testcases for GDB

Wiki: Started a page on how to write testcases for GDB

[Joel Brobecker]

Hello,

I found that I was always asking myself the very same questions
every time I have to write a new testcase, so I had this secret
plan of writing a HOWTO, or a cookbook.  I have just started a new
page in the GDB wiki, summarizing some of the things I know:

    http://sourceware.org/gdb/wiki/GDBTestcaseCookbook

It's only a start, so please feel free to correct and complete.
For instance, I just remembered that I forgot to mention gdb_test
and gdb_test_multiple vs send_gdb/gdb_expect.  Will do immediately.

-- 
Joel

Re: Wiki: Started a page on how to write testcases for GDB

[Joel Brobecker]

> I found that I was always asking myself the very same questions
> every time I have to write a new testcase, so I had this secret
> plan of writing a HOWTO, or a cookbook.  I have just started a new
> page in the GDB wiki, summarizing some of the things I know:
> 
>     http://sourceware.org/gdb/wiki/GDBTestcaseCookbook

BTW: I should mention that the goal of this page is to help people
write consistent testcases, simplify their writing by pointing out
some useful convenience routines, helping avoiding common pitfals,
etc.  Right now, the testsuite looks  like a genetic experiment:
Every testcase is different from the other! To write a new testcase,
you marry two existing ones, they have lots of sex, and then start
producing new testcases that look like their parents, but are not
quite like their parents.

-- 
Joel

Re: Wiki: Started a page on how to write testcases for GDB

[Eli Zaretskii]

> Date: Sat, 26 Dec 2009 09:44:48 +0400
> From: Joel Brobecker <brobecker@adacore.com>
> 
> I found that I was always asking myself the very same questions
> every time I have to write a new testcase, so I had this secret
> plan of writing a HOWTO, or a cookbook.  I have just started a new
> page in the GDB wiki, summarizing some of the things I know:
> 
>     http://sourceware.org/gdb/wiki/GDBTestcaseCookbook

Thanks.

It would be nice to have this as part of gdbint.texinfo as well.

Re: Wiki: Started a page on how to write testcases for GDB

[Joel Brobecker]

> Thanks.
> It would be nice to have this as part of gdbint.texinfo as well.

I think we should put the info in either document, but not both, or
we would be duplicating the info.  I chose the Wiki because it's very
easy to update and maintain.  To be honest, I don't think I will have
the courage to make fixes if it means having to go through the normal
review process.

-- 
Joel

Re: Wiki: Started a page on how to write testcases for GDB

[Eli Zaretskii]

> Date: Sat, 26 Dec 2009 12:56:56 +0400
> From: Joel Brobecker <brobecker@adacore.com>
> Cc: gdb@sourceware.org
> 
> > Thanks.
> > It would be nice to have this as part of gdbint.texinfo as well.
> 
> I think we should put the info in either document, but not both, or
> we would be duplicating the info.  I chose the Wiki because it's very
> easy to update and maintain.  To be honest, I don't think I will have
> the courage to make fixes if it means having to go through the normal
> review process.

You don't need to add this to gdbint.texinfo until it's in good shape
and sufficiently complete.  Likewise, not every change on the wiki
needs to be immediately reflected in the manual, you can do that only
after a substantial amount of changes went in.  OTOH, fixing a typo or
some similar trivial correction don't need to be reviewed, and if they
are, the result is known in advance.

IOW, I'm willing to make a lot of allowances if that will convince you ;-)

My rationale is very simple: if we start putting important parts of
documentation on the wiki, then why maintain the manuals at all?

Re: Wiki: Started a page on how to write testcases for GDB

[Christopher Faylor]

On Sat, Dec 26, 2009 at 11:08:35AM +0200, Eli Zaretskii wrote:
>> Date: Sat, 26 Dec 2009 12:56:56 +0400
>> From: Joel Brobecker <brobecker@adacore.com>
>> Cc: gdb@sourceware.org
>> 
>> > Thanks.
>> > It would be nice to have this as part of gdbint.texinfo as well.
>> 
>> I think we should put the info in either document, but not both, or
>> we would be duplicating the info.  I chose the Wiki because it's very
>> easy to update and maintain.  To be honest, I don't think I will have
>> the courage to make fixes if it means having to go through the normal
>> review process.
>
>You don't need to add this to gdbint.texinfo until it's in good shape
>and sufficiently complete.  Likewise, not every change on the wiki
>needs to be immediately reflected in the manual, you can do that only
>after a substantial amount of changes went in.  OTOH, fixing a typo or
>some similar trivial correction don't need to be reviewed, and if they
>are, the result is known in advance.
>
>IOW, I'm willing to make a lot of allowances if that will convince you ;-)
>
>My rationale is very simple: if we start putting important parts of
>documentation on the wiki, then why maintain the manuals at all?

I don't suppose there's any way to grab the info from the wiki and
put it in the texinfo document or vice-versa?

cgf