[blfs-dev] Doxygen instructions

Pierre Labastie pierre.labastie at neuf.fr
Tue Sep 8 00:31:02 PDT 2015


On 07/09/2015 21:23, Fernando de Oliveira wrote:
> Em 07-09-2015 15:57, Fernando de Oliveira escreveu:
>> Em 07-09-2015 13:16, Pierre Labastie escreveu:
>>> Hi,
>>>
>>> The current instructions for doxygen seem wrong to me:
>>> Actually, the part
>>> -----------------------
>>> install -vm644 ../doc/*.1 /usr/man/man1
>>> -------------------
>>> generates the error:
>>> -----------------
>>> install: target '/usr/man/man1' is not a directory
>>> -----------------
>>> Furthermore, the "make install" step returns:
>>> -----------------
>>> [...]
>>> -- Install configuration: "Release"
>>> -- Installing: /usr/bin/doxygen
>>> -- Installing: /usr/share/man/man1/doxygen.1
>>> -- Installing: /usr/share/man/man1/doxywizard.1
>>> -- Installing: /usr/share/man/man1/doxysearch.1
>>> -- Installing: /usr/share/man/man1/doxyindexer.1
>>> -- Installing: /usr/share/doc/doxygen-1.8.10/doxygen_manual.pdf
>>> [...]
>>> ------------------
>>>
>>> So it seems that "make install" is enough for getting the manuals.
>>> Furthermore, the next instruction "make docs install" is not needed,
>>> since the documentation is installed in the preceding step, as shown
>> above.
>>> Did I miss something? If not, I can fix that at my next commit.
>>>
>>> Pierre
>> Works for me:
>>
>> {{{
>>        mkdir build &&
>>        cd build &&
>>
>>        cmake -G "Unix Makefiles"         \
>>              -DCMAKE_BUILD_TYPE=Release  \
>>              -DCMAKE_INSTALL_PREFIX=/usr \
>>              -Dbuild_search=ON           \
>>              -Dbuild_wizard=ON           \
>>              -Dbuild_xmlparser=ON        \
>>              .. &&
>>
>>        time make -j${MKFLGS} &&
>>
>>        time make -j${MKFLGS} DESTDIR=$DESTINODIR install        &&
>>        install -v -d -m 755            $DESTINODIR/usr/man/man1 &&
>>        install -v    -m 644 ../doc/*.1 $DESTINODIR/usr/man/man1 &&
>> }}}
>>
>>
>>
>> {{{
>> [ 98%] Building CXX object src/CMakeFiles/doxygen.dir/main.cpp.o
>> [100%] Linking CXX executable ../bin/doxygen
>> [100%] Built target doxygen
>>
>> real 2m16.972s
>> user 9m10.506s
>> sys 0m10.336s
>> [ 1%] Built target md5
>> [ 8%] Built target doxycfg
>> [ 9%] Built target vhdlparser
>> [ 10%] Built target doxysearch.cgi
>> [ 25%] Built target qtools
>> [ 26%] Built target doxyindexer
>> [ 41%] Built target doxywizard
>> [ 98%] Built target _doxygen
>> [100%] Built target doxygen
>> Install the project...
>> -- Install configuration: "Release"
>> -- Installing: /tmp/DEST-doxygen-1.8.10/usr/bin/doxygen
>> -- Installing: /tmp/DEST-doxygen-1.8.10/usr/bin/doxyindexer
>> -- Installing: /tmp/DEST-doxygen-1.8.10/usr/bin/doxysearch.cgi
>> -- Installing: /tmp/DEST-doxygen-1.8.10/usr/bin/doxywizard
>> -- Removed runtime path from "/tmp/DEST-doxygen-1.8.10/usr/bin/doxywizard"
>>
>> real 0m0.196s
>> user 0m0.317s
>> sys 0m0.095s
>> install: criando o diretório “/tmp/DEST-doxygen-1.8.10/usr/man”
>> install: criando o diretório “/tmp/DEST-doxygen-1.8.10/usr/man/man1”
>> “../doc/doxygen.1” -> “/tmp/DEST-doxygen-1.8.10/usr/man/man1/doxygen.1”
>> “../doc/doxyindexer.1” ->
>> “/tmp/DEST-doxygen-1.8.10/usr/man/man1/doxyindexer.1”
>> “../doc/doxysearch.1” ->
>> “/tmp/DEST-doxygen-1.8.10/usr/man/man1/doxysearch.1”
>> “../doc/doxywizard.1” ->
>> “/tmp/DEST-doxygen-1.8.10/usr/man/man1/doxywizard.1”
>> }}}
>>
>> I'm now running with all docs, I remember that in that case there was a
>> duplication, but I didn't care, because for me the important was the
>> normal user having the man pages.
>>
>>
>
> OK.
>
> We have:
>
> {{{
> If you generated the package documentation, install with the following
> command, as the root user:
>
> make docs install
> }}}
>
> It was needed by my scripts, because I did the hole install as above,
> and later generated the other docs and installed.
>
> Those two lines can be removed.
>
> There will be a redundancy
>
>> install: criando o diretório “/tmp/DEST-doxygen-1.8.10/usr/man”
>> install: criando o diretório “/tmp/DEST-doxygen-1.8.10/usr/man/man1”
>> “../doc/doxygen.1” -> “/tmp/DEST-doxygen-1.8.10/usr/man/man1/doxygen.1”
>> “../doc/doxyindexer.1” ->
>> “/tmp/DEST-doxygen-1.8.10/usr/man/man1/doxyindexer.1”
>> “../doc/doxysearch.1” ->
>> “/tmp/DEST-doxygen-1.8.10/usr/man/man1/doxysearch.1”
>> “../doc/doxywizard.1” ->
>> “/tmp/DEST-doxygen-1.8.10/usr/man/man1/doxywizard.1”
> But this can be solved by splinting the install command:
>
> {{{
> Now, as the root user:
>
> make install
>
> If you have not generated the the package documentation, install the man
> pages, as the root user:
>
> install -vm644 ../doc/*.1 /usr/man/man1
> }}}
>
> Although I would prefer just to remove the two las line and leave the
> rest as is.
>
> But I never got any error as you did and that, I don't understand...
> unless you are including the switch.
>
>
Thanks for the answer Fernando, I understand better: instructions for 
installing manpages are needed for those who do not use "make docs". But 
I get an error because /usr/man does not exist on my system, only 
/usr/share/man. Maybe you still have the symlink /usr/man-> 
/usr/share/man ? I'll add "/share" and remove the last two lines on my 
next commit, unless you beat me on this.

Pierre



More information about the blfs-dev mailing list