KDevelop Manual

[Joe Dev]

Hello,

> We haven't had much to do with the kdevelop doc for the last few years, so
> I am cc'ing there in case they prefer to continue managing their
> documentation themselves.
So who manages their documentation now?

> Either way, you're welcome to use this list for proofreading/style/docbook
> assistance if you want.  In fact, if you don't want to write docbook, you
> can send plain text here and we'll do the markup for you.
I sure will need some help at the beginning. 
But in the long run, I'd prefer to do the markup myself,
according to your or the KDevelop people's guidelines.
By the way, in
http://i18n.kde.org/doc/markup/tags-we-dont-use.html
you list <formalpara> as a tag you don't use.
However, it is widely used e.g. in:
kdevelop/doc/kdevelop/index.docbook.
So what is true now?

And in http://i18n.kde.org/doc/tools.php,
how about listing Quanta?

So here is my diff of index.docbook as a first try.
It's surely not perfect and I'd appreciate corrections. 
Don't hesitate to express criticism;
it's better to clarify these issues at the beginning, 
before I invest much work.

Regards,

Joe Dev
-------------- next part --------------
? kdevelop/buildtools/autotools/autoprojectviewbase.cpp
? kdevelop/buildtools/autotools/autoprojectviewbase.h
? kdevelop/languages/cpp/app_templates/kscons_kmdi/Makefile
? kdevelop/languages/cpp/app_templates/kscons_kmdi/Makefile.in
? kdevelop/languages/cpp/app_templates/kscons_kxt/Makefile
? kdevelop/languages/cpp/app_templates/kscons_kxt/Makefile.in
Index: kdevelop/doc/kdevelop/index.docbook
===================================================================
RCS file: /home/kde/kdevelop/doc/kdevelop/index.docbook,v
retrieving revision 1.73
diff -r1.73 index.docbook
1294a1295,1300
> 
> <para>If you try to debug a project without debugging information,
> you get the message "No source..." in the status bar.
> If you try to set a breakpoint, it is shown as "Pending (add)"
> in the breakpoint window (see below).
> </para>
1330c1336,1394
< (... to be written ...)
---
> This window allows you to see and manipulate the breakpoints. 
> Remember that KDevelop uses GDB, so to fully understand the 
> KDevelop debugging features, you should know a little bit about the 
> <ulink url="http://www.gnu.org/software/gdb">GDB</ulink>.
> </para>
> 
> <para>If you want to look at the source code,
> breakpoints are defined in 
> kdevelop/languages/cpp/debugger/breakpoint.h.
> </para>
> 
> <para>
> At the left edge, the window has buttons to:
> <itemizedlist>
> <listitem><para>Add an empty breakpoint</para></listitem>
> <listitem><para>Edit the selected breakpoint</para></listitem>
> <listitem><para>Delete the selected breakpoint</para></listitem>
> <listitem><para>Remove all breakpoints</para></listitem>
> </itemizedlist>
> </para>
> 
> <para>
> The main part of the window is a table with 7 columns.
> Each line in the table is a breakpoint.
> The columns are:
> <orderedlist>
> <listitem><para>Selection checkbox</para></listitem>
> <listitem><para>Type: one of: Invalid, File:Line, Watchpoint, Address, Function</para></listitem>
> <listitem><para>Status. Values are:
> <itemizedlist>
> <listitem><para>Active</para></listitem>
> <listitem><para>Disabled: Each breakpoint may be "enabled" or "disabled"; if
> disabled, it has no effect on your program until you enable it again.</para></listitem>
> <listitem><para>Pending (add): a breakpoint is marked like this if no debugging information is available.
> From GDB Info page:
> <blockquote>  If a specified breakpoint location cannot be found, it may be due to
> the fact that the location is in a shared library that is yet to be
> loaded.  In such a case, you may want GDB to create a special
> breakpoint (known as a "pending breakpoint") that attempts to resolve
> itself in the future when an appropriate shared library gets loaded.
> </blockquote>
> </para></listitem>
> <listitem><para>Pending (clear)</para></listitem>
> <listitem><para>Pending (modify)</para></listitem>
> 
> </itemizedlist>
> 
> 
> </para></listitem>
> <listitem><para>Location in the format filename:linenumber</para></listitem>
> <listitem><para>Condition</para></listitem>
> <listitem><para>Ignore Count: If this is a number COUNT greater than zero, the next
>      COUNT times the breakpoint is reached, your program's execution
>      does not stop; other than to decrement the ignore count, GDB takes
>      no action.</para></listitem>
> <listitem><para>Hits: counts how many times a breakopint has been hit.</para></listitem>
> 
> </orderedlist>
> 
1331a1396,1397
> 
>