Commit fef56b89 authored by gerd's avatar gerd

release 0.6.2

fixing doc issues, release notes


git-svn-id: https://gps.dynxs.de/private/svn/app-plasma/trunk@636 55289a75-7b90-4627-9e07-ffb4263930b2
parent c34cb9e0
......@@ -42,7 +42,7 @@ set_defaults () {
ocamlc=`get_path ocamlc`
set_defaults
version="0.6.1"
version="0.6.2"
######################################################################
......
......@@ -100,3 +100,5 @@ odoc/chtml.cmo:
clean:
rm -rf html
cd odoc; $(MAKE) clean
rm -f sessions/sessions.idoc
.PHONY: all
all: chtml.cmo x_to_odoc
chtml.ml:
ln -s chtml_ocaml4.ml chtml.ml
chtml.cmo: chtml.ml
ocamlc -I +ocamldoc -c chtml.ml
......@@ -11,6 +14,7 @@ x_to_odoc: x_to_odoc.ml
clean:
rm -f *.cmi *.cmo
rm -f x_to_odoc
rm -f chtml.ml
.PHONY: CLEAN
CLEAN: clean
......
(* Our custom HTML generator *)
(* Define
{picture file.png Caption Text}
so images can be easily included into ocamldoc documentation
Define
{directinclude <true>|<false>}
changing the bahviour of "include Module". If direct include is enabled,
the included stuff is directly shown.
Define
{fixpxpcoretypes <true>|<false>}
If enabled, this mode changes all clickable references
- of Pxp_core_types.I.<id> into Pxp_types.<id>, and
- of Pxp_core_types.S.<id> into Pxp_types.<id>
Define
{knowntype identifier}
{knownclass identifier}
to enter additional names into the tables of type and class names
for which links are generated
*)
open Printf
open Odoc_info
open Module
module StringSet = Odoc_html.StringSet
let word_re = Str.regexp "[ \t\r\n]+"
let split_args t =
match t with
| [] -> []
| [Odoc_info.Raw arg] -> Str.split word_re arg
| _ ->
failwith "Argument too complicated"
module Generator (G : Odoc_html.Html_generator) = struct
class html =
object(self)
inherit G.html as super
method private html_of_picture b t =
let (file, caption) =
match split_args t with
| [] ->
failwith "{picture ...} needs at least one argument"
| w ->
( match w with
| file :: args ->
(file, String.concat " " args)
| [] ->
failwith "{picture ...} needs a simple word as first argument"
) in
bprintf b
"<div class=\"picture\">\
<div class=\"picture-caption\">%s</div>\
<img src=\"%s\">\
</div>"
(self#escape caption)
file
val mutable enable_direct_include = false
method private html_of_direct_include b t =
match split_args t with
| ["true"] ->
enable_direct_include <- true
| ["false"] ->
enable_direct_include <- false
| _ ->
failwith "{directinclude ...} needs one bool argument"
method html_of_included_module b im = (* overridden! *)
super # html_of_included_module b im;
if enable_direct_include then (
match im.im_module with
| None -> () (* case module is unknown *)
| Some (Mod m) ->
bprintf b "<div class=\"included-module\">\n";
List.iter
(self#html_of_module_element b (Name.father m.m_name))
(Module.module_elements m);
bprintf b "</div>\n"
| Some (Modtype mt) ->
bprintf b "<div class=\"included-module-type\">\n";
List.iter
(self#html_of_module_element b (Name.father mt.mt_name))
(Module.module_type_elements mt);
bprintf b "</div>\n"
)
val mutable enable_fix_pxp_core_types = false
method private html_of_fix_pxp_core_types b t =
match split_args t with
| ["true"] ->
enable_fix_pxp_core_types <- true
| ["false"] ->
enable_fix_pxp_core_types <- false
| _ ->
failwith "{fixpxpcoretypes ...} needs one bool argument"
val pxp_core_types_re = Str.regexp "Pxp_core_types\\.[SI]\\."
method create_fully_qualified_idents_links m_name s =
let s' =
if enable_fix_pxp_core_types then (
Str.global_replace pxp_core_types_re "Pxp_types." s
)
else
s in
super # create_fully_qualified_idents_links m_name s'
method html_of_Ref b name ref_opt =
let name' =
if enable_fix_pxp_core_types then (
(* prerr_endline ("Ref: " ^ name); *)
Str.global_replace pxp_core_types_re "Pxp_types." name
)
else
name in
super # html_of_Ref b name' ref_opt
method html_of_custom_text b s t =
let add_known_type t =
List.iter
(fun s ->
known_types_names <- StringSet.add s known_types_names
)
(split_args t) in
let add_known_class t =
List.iter
(fun s ->
known_classes_names <- StringSet.add s known_classes_names
)
(split_args t) in
match s with
| "picture" -> self#html_of_picture b t
| "directinclude" -> self#html_of_direct_include b t
| "fixpxpcoretypes" -> self#html_of_fix_pxp_core_types b t
| "knowntype" -> add_known_type t
| "knownclass" -> add_known_class t
| _ -> ()
end
end
let _ =
Odoc_args.extend_html_generator (module Generator : Odoc_gen.Html_functor)
......@@ -7,6 +7,12 @@ for broader testing.
{3 Changed in 0.6.2}
New platform:
- Plasma works now on MacOS X. Some optional features remain unimplemented,
though, especially the shared memory transport for PlasmaFS. You need
Ocamlnet-3.6.1 or better. MacOS X is mainly interesting as development
platform - do not expect exceptional performance.
Fixes:
- Detecting ocamlnet-3.6 (and better), and requiring netstring-pcre as
additional findlib dependency
......@@ -22,6 +28,8 @@ New features:
split into parts processed by different processes in order to
improve data locality.
- New [options] argument of {!Mapred_main.exec_job}
- One can now specify the root of the NFS-mounted filesystem
- New flags for [write_file]
{3 Changed in 0.6.1}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment