Open MPI logo

Hardware Locality Development Mailing List Archives

  |   Home   |   Support   |   FAQ   |   all Hardware Locality Development mailing list

Subject: Re: [hwloc-devel] [hwloc-svn] svn:hwloc r4619 - trunk/doc
From: Brice Goglin (Brice.Goglin_at_[hidden])
Date: 2012-07-17 04:06:53


FYI, I may revert this before the final v1.5.

Doxygen >= 1.8 does not put code fragments inside <pre> tags anymore.
They use the CSS to make sure indentation is preserved (we should update
out own CSS), but that doesn't seem to work with w3m and lynx. That's
why hello.c is not indented anymore in the README. Currently under
discussion at https://bugzilla.gnome.org/show_bug.cgi?id=680073 but I
don't expect much.

The patch below fixes indentation in the README (verbatim forces <pre>
tags) but it removes doxygen syntax colorizing in the HTML and PDF
outputs, which is bad IMHO.

One workaround would be to modify the doxygen HTML code before passing
it to w3m/lynx and try to fix this mess. We'll see.
We may need such a step anyway because w3m does not export everything
well. For instance &ndash; (generated by doxygen in place of -- since
1.8) and © are exported as "?".

Another way would be to manually insert hello.c in the README in place
of the doxygen-generated code.

Brice

Le 16/07/2012 15:13, svn-commit-mailer_at_[hidden] a écrit :
> Author: bgoglin (Brice Goglin)
> Date: 2012-07-16 09:13:45 EDT (Mon, 16 Jul 2012)
> New Revision: 4619
> URL: https://svn.open-mpi.org/trac/hwloc/changeset/4619
>
> Log:
> doxy: use \verbinclude instead of \include for hwloc-hello
>
> Otherwise the contents is considered normal text and thus
> reindented by recent doxygen releases.
>
> Text files modified:
> trunk/doc/hwloc.doxy | 2 +-
> 1 files changed, 1 insertions(+), 1 deletions(-)
>
> Modified: trunk/doc/hwloc.doxy
> ==============================================================================
> --- trunk/doc/hwloc.doxy Mon Jul 16 08:17:45 2012 (r4618)
> +++ trunk/doc/hwloc.doxy 2012-07-16 09:13:45 EDT (Mon, 16 Jul 2012) (r4619)
> @@ -525,7 +525,7 @@
> topology of the machine and bring the process to the first logical processor
> of the second core of the machine.
>
> -\include hwloc-hello.c
> +\verbinclude hwloc-hello.c
>
> hwloc provides a \c pkg-config executable to obtain relevant compiler
> and linker flags. For example, it can be used thusly to compile
> _______________________________________________
> hwloc-svn mailing list
> hwloc-svn_at_[hidden]
> http://www.open-mpi.org/mailman/listinfo.cgi/hwloc-svn