[erlang-bugs] Typographic defects in R11B-0 to R11B-5 HTML docs
G Bulmer
gbulmer@REDACTED
Thu Aug 30 23:56:40 CEST 2007
There are 5 typographic defects in the R11B-0 to R11B-5 HTML
documentation in file:
/usr/local/lib/erlang/lib/kernel-2.11.5/doc/html/file.html
At:
file.html:3288: ok = file:write(FD, <<M:32/
unsigned>>),
file.html:3306:create_file(FD, M, N) when M + 1024 =< N ->
file.html:3314:create_file(FD, M, N0, R) when M + 8 =< N0 ->
file.html:3318: [<<N8:32/unsigned,
N7:32/unsigned,
file.html:3324:
These are in the "Performance" section, near the end of the page.
Firefox renders:
create_file_slow(FD, M, N) ->
ok = file:write(FD, <<M:32/unsigned>>),
create_file_slow(FD, M+1, N).
I believe this should read:
create_file_slow(FD, M, N) ->
ok = file:write(FD, <<M:32/unsigned>>),
create_file_slow(FD, M+1, N).
Later on the same page, there is:
create_file(FD, M, N) when M + 1024 =< N ->
instead of:
create_file(FD, M, N) when M + 1024 =< N ->
Earlier versions of the documentation do not appear to suffer this
defect:
lib/kernel-2.8.0/doc/html/file.html,
lib/kernel-2.10/doc/html/file.html, and
lib/kernel-2.10.13/doc/html/file.html are okay.
But lib/kernel-2.11/doc/html/file.html contains errors.
The HTML source should read:
ok = file:write(FD, <<M:32/unsigned>>),
but in ... lib/kernel-2.11.5/doc/html/file.html, it reads:
ok = file:write(FD, <<M:32/unsigned>>),
The HTML escape for '&' has been used, rather than the escape for
'<'. There are several explanations, but it's worth noting < is an
escape for '<', and & is an escape for '&'.
I've grep'ed through the R11B-5 HTML document files, and these have a
single defect:
/usr/local/lib/erlang/doc/design_principles/sup_princ.html:121:
Shutdown = brutal_kill | integer() >=0 | infinity
/usr/local/lib/erlang/erts-5.5.5/doc/html/epmd.html:103:
*&ld;TABs>/var/log/epmd.log
GB
More information about the erlang-bugs
mailing list