|
|
| Author |
Message |
|
| Guest |
 Posted: Fri Dec 11, 2009 1:52 pm |
 |
|
|
Guest
|
Hi!
I'm trying to build Erlang documentation from the sources (the goal is
to switch from prebuilt docs for Debian Erlang packages as building
them from the source is preferable).
To do that I run
make
make TYPE=docs
(in fact, make libs doesn't recognize TYPE, so I had to replace "make
opt" by "make $(TYPE) in the top-level Makefile).
and I've found several problems which make build fail:
1) For some XML files (e.g. erts/docs/src/book.xml) xsltproc reports
runtime errors about undefined variables (partnum in line 871 and 963
of db_pdf.xsl, in lines 1075 and 1173 of db_html.xsl). Is this a bug
in the stylesheets or in xsltproc? (Both 1.1.24 from Debian stable and
1.1.26 from Debian unstable failed.)
2) wx application has duplicated targets html and docs in its makefile.
3) wx application (and others too) require docb_gen script to generate
XML docs sources. It is missing. (I suppose that it is a simple
wrapper around docb_gen Erlang module and could be recreated, but It'd
be better if it were shipped in Erlang sources.)
Is Erlang documentation supposed to be buildable from the source, or
it still requires some unavailable tools?
Cheers!
--
Sergei Golovan
________________________________________________________________
erlang-bugs mailing list. See http://www.erlang.org/faq.html
erlang-bugs (at) erlang.org
Post received from mailinglist |
|
|
| Back to top |
|
| Guest |
| Posted: Mon Dec 14, 2009 9:33 am |
|
|
|
Guest
|
Hi Sergei,
we started to build our documentation with open source tools in R13B03 so it
would be possible to build the doc from the delivered sources.
But it's still only built in house because we hadn't time to test it but the plan is
to have it work for everyone in R13B04.
Thanks for your report, we'll have a look at those fault.
Regards Lars
Sergei Golovan wrote:
> Hi!
>
> I'm trying to build Erlang documentation from the sources (the goal is
> to switch from prebuilt docs for Debian Erlang packages as building
> them from the source is preferable).
>
> To do that I run
> make
> make TYPE=docs
> (in fact, make libs doesn't recognize TYPE, so I had to replace "make
> opt" by "make $(TYPE) in the top-level Makefile).
>
> and I've found several problems which make build fail:
>
> 1) For some XML files (e.g. erts/docs/src/book.xml) xsltproc reports
> runtime errors about undefined variables (partnum in line 871 and 963
> of db_pdf.xsl, in lines 1075 and 1173 of db_html.xsl). Is this a bug
> in the stylesheets or in xsltproc? (Both 1.1.24 from Debian stable and
> 1.1.26 from Debian unstable failed.)
>
> 2) wx application has duplicated targets html and docs in its makefile.
>
> 3) wx application (and others too) require docb_gen script to generate
> XML docs sources. It is missing. (I suppose that it is a simple
> wrapper around docb_gen Erlang module and could be recreated, but It'd
> be better if it were shipped in Erlang sources.)
>
> Is Erlang documentation supposed to be buildable from the source, or
> it still requires some unavailable tools?
>
> Cheers!
________________________________________________________________
erlang-bugs mailing list. See http://www.erlang.org/faq.html
erlang-bugs (at) erlang.org
Post received from mailinglist |
|
|
| Back to top |
|
| Guest |
| Posted: Mon Dec 14, 2009 10:03 am |
|
|
|
Guest
|
Hi!
I did some further investigations and found that simply calling make
in all doc/src
directories works better then trying to run make recursively.
pwd=`pwd`
for i in `find . -wholename '*/doc/src'` ; do
(cd $i ; make man ERL_TOP=$pwd )
done
(using Erlang R12B-02-1 edoc and docbuilder, and the attached docb_gen script)
generates manpages perfectly, make html and make pdf though suffer from runtime
errors while running xsltproc.
Running make recursively reveals a whole bunch of problems with
missing and redefined
'docs' targets in makefiles.
On Mon, Dec 14, 2009 at 12:16 PM, <lars@erix.ericsson.se> wrote:
> Hi Sergei,
> we started to build our documentation with open source tools in R13B03 so it
> would be possible to build the doc from the delivered sources.
>
> But it's still only built in house because we hadn't time to test it but the plan is
> to have it work for everyone in R13B04.
>
> Thanks for your report, we'll have a look at those fault.
>
> Regards Lars
>
>
> Sergei Golovan wrote:
>> Hi!
>>
>> I'm trying to build Erlang documentation from the sources (the goal is
>> to switch from prebuilt docs for Debian Erlang packages as building
>> them from the source is preferable).
>>
>> To do that I run
>> make
>> make TYPE=docs
>> (in fact, make libs doesn't recognize TYPE, so I had to replace "make
>> opt" by "make $(TYPE) in the top-level Makefile).
>>
>> and I've found several problems which make build fail:
>>
>> 1) For some XML files (e.g. erts/docs/src/book.xml) xsltproc reports
>> runtime errors about undefined variables (partnum in line 871 and 963
>> of db_pdf.xsl, in lines 1075 and 1173 of db_html.xsl). Is this a bug
>> in the stylesheets or in xsltproc? (Both 1.1.24 from Debian stable and
>> 1.1.26 from Debian unstable failed.)
>>
>> 2) wx application has duplicated targets html and docs in its makefile.
>>
>> 3) wx application (and others too) require docb_gen script to generate
>> XML docs sources. It is missing. (I suppose that it is a simple
>> wrapper around docb_gen Erlang module and could be recreated, but It'd
>> be better if it were shipped in Erlang sources.)
>>
>> Is Erlang documentation supposed to be buildable from the source, or
>> it still requires some unavailable tools?
>>
>> Cheers!
>
>
--
Sergei Golovan
Post received from mailinglist |
|
|
| Back to top |
|
| Guest |
| Posted: Mon Dec 21, 2009 9:09 am |
|
|
|
Guest
|
Hi Sergei,
someone in the beginning of OTP history decided to place them there
and I don' remember why. I don't know if Erlang users expect them to be there
but they have at least got used to it  .
I think your suggestion is appropriate and we'll look at it
but I don't know if we change.
Regards Lars
Erlang/OTP, Ericsson AB
Sergei Golovan wrote:
> Hi again!
>
> And another issue with Erlang manpages:
>
> Erlang places manpages for its config files into section 4 and
> application descriptions into section 6. Though man manual says that
> section 4 is for "special files (usually found in /dev)" and section 6
> is for "games" (?!).
>
> I'd say that config files manpages are to be in section 5 "file
> formats and conventions" and applications - in section 7 (just don't
> fit any other section).
>
> Would it be too hard to move manpages across sections (This will
> require some minor changes to Erlang mode as well)? Or Erlang users
> expect them in sections 4 and 6, so they couldn't find them elsewhere?
>
________________________________________________________________
erlang-bugs mailing list. See http://www.erlang.org/faq.html
erlang-bugs (at) erlang.org
Post received from mailinglist |
|
|
| Back to top |
|
|
|
All times are GMT
|
|
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
You cannot attach files in this forum
You cannot download files in this forum
|
|
|
Digg It
Del.icio.us
Reddit
Facebook
Stumble Upon
Technorati
