Re: [documentation] Port to mallard, request for review

[Dodji Seketeli <dodji seketeli org>]

Hello Baptiste,

Sorry for my late reply to this message.

Baptiste Mille-Mathias <baptistem gnome org> a écrit:

> During the last months, I tried to rewrite the user documentation from
> docbook to mallard which is the format for the cool kids :).

This is great man, thank you so much for doing this.  You cannot imagine
how much I appreciate this.

> Now you read and spot my mistakes (technical and grammatical).

I have started to review the thing and I thought I'd send you my comments
gradually as I find them.  I try to bundle them just enough for them to
make sense and send them to you.

So here is my first comment.

I couldn't build the doc by changing directory into the help/
sub-directory of my build directory and by doing "make".

I started having errors like:

    make[2] : on entre dans le répertoire « /home/dodji/git/nemiver/dodji-mallard-docs/build/help »
    make[2]: ***  Aucune règle pour fabriquer la cible « C/index.docbook », nécessaire pour « all ». Arrêt.
    make[2] : on quitte le répertoire « /home/dodji/git/nemiver/dodji-mallard-docs/build/help »
    make[1]: *** [all-recursive] Erreur 1
    make[1] : on quitte le répertoire « /home/dodji/git/nemiver/dodji-mallard-docs/build »
    make: *** [all] Erreur 2

    Compilation exited abnormally with code 2 at Sun Sep  1 18:45:32

So basically help/Makefile.am is still referring to files that are not
in the help/C/ source sub-tree anymore.

So below is the patch I came up with to make the thing build the docs.

If that is okay to you, I think you should apply the in the mallard-docs
branch so that others can build the docs.  Otherwise, let me know if I
forgot any thing.

I'll post the remaining of my other comments soon.

Thank you very much.

diff --git a/help/Makefile.am b/help/Makefile.am
index abee34f..bbe7d79 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -3,23 +3,12 @@
 HELP_ID = nemiver
 
 HELP_FILES = \
-       index.docbook \
+       index.page \
        legal.xml
 
 HELP_MEDIA = \
-                         figures/attach-dialog.png \
-                         figures/execute-dialog.png \
-                         figures/load-core-dialog.png \
-                         figures/main-window.png \
-                         figures/sessions-dialog.png \
-                         figures/variable-inspector.png \
-                         figures/set-breakpoint-dialog.png \
-                         figures/open-files-target.png \
-                         figures/global-variables-dialog.png \
-                         figures/memory-view.png \
-                         figures/registers-view.png \
-                         figures/connect-remote-dialog.png \
-                         figures/enabled-breakpoint.png \
-                         figures/disabled-breakpoint.png
+       figures/main-interface.png \
+       figures/nemiver.png \
+       $(NULL)
 
 HELP_LINGUAS = cs de el es fr gl oc sl sv zh_CN

-- 
                Dodji