foretspaisibles / bsdowl Goto Github PK

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/31
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-08-12T13:27:17.973

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/33
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-08-12T13:28:51.148

Trying to install bsdowl on Cygwin fails with the following error:

sh: -c: line 0: syntax error near unexpected token `('
sh: -c: line 0: `env -i PATH=[...] bmake   -f /dev/null -V MAKEOBJDIR nothing'

The errors seems to be produced by the file bps.objdir.mk.

It pops a ghostscript interpreter which must be closed manually.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/41
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-09-17T08:48:40.713

We want a broader support of compiler options in our OCaml supporting modules. Available options should also get better names. Things under consideration:

• Define phony flags like USE_PROFILER and so on
• Rename the TARGET variable and choose other suffixes
• Rework the logic of flags and document it in a sensible way

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/4
• Originally Reported By: Michael Grünewald
• Originally Created At: 2013-10-03T13:52:48.905

We want to support outputformat and outputtemplate, so that they can be tweaked from the Makefile or supplied in standalone files.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/24
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-06-19T14:11:52.992

When a lexer file is accompanied by a documented interface, the latter is ignored by ocamldoc.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/28
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-08-09T14:06:23.658

The ocaml.dirs.mk module relies on OCAMLCI to find -where OCaml is installed. This breaks with some packages.

For instance the threads package needs the -thread or -vmthread option.

Encoding the relevant directory at compile time will not do, because it would forbid the use of other compiler toolchains as the one choosed at configuration time.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/13
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-04-12T14:45:14.899

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/32
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-08-12T13:27:51.022

We currently hard code some utilities name in our definitions. It is better to let the user configure them. These utilities are:

• OCaml compilers in ocaml/*, probably ocaml.tools.mk
• ocamllex, ocamlyacc, ocamlfind, ocamldep, ocamldoc in ocaml/*
• tidy in www/www.sgml.mk
• onsgmls in www/www.sgml.mk

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/11
• Originally Reported By: Michael Grünewald
• Originally Created At: 2013-10-19T22:45:51.698

Decide if PACKAGE is always more appropriate than PROJECT or if we just keep the name PACKAGE to provide some similarity with GNU Autotools.

Also, it could be appropriate to rename PROJECTAUTHOR to PROJECTOFFICER, because the PROJECTAUTHOR does not need to be the sole author of the project.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/38
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-09-07T10:59:56.436

We could allow choosing between bytecode compilers and optimised compilers when building ocaml projects.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/18
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-05-01T12:22:17.025

When using the mp2pdf support command, a noisy message

Usage: file [-bchikLlNnprsvz0] [--apple] [--mime-encoding] [--mime-type]
        [-e testname] [-F separator] [-f namefile] [-m magicfiles] file ...
   file -C [-m magicfiles]
   file [--help]

is printed.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/23
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-06-17T23:15:29.053

Debian Wheezy provides version 1.111-3.2 of pmake and not any version of bmake. For users which cannot upgrade to jessie, we need to support our TeX building chain.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/26
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-06-27T08:59:31.641

We want to get rid of bitrot in the repository. Here is a list of things to review:

• Library/Ancillary There is some old scripts there. Determine what is obsolete, what has some value, and leave only up to date and useful scripts there.
• Website is now a wiki, but it could be recycled as an example of a static website.
• Library/Template Must be cleaned up.
• snippets and rox should probably be dropped
• test must be reworked.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/6
• Originally Reported By: Michael Grünewald
• Originally Created At: 2013-10-03T14:12:33.458

List building tests for TeX and prepare an issue for each of them.

Thanks to the write18 construct, some TeX/LaTeX packages can convert METAPOST encapsulated PostScript (MPS) to a format appropriate for inclusion in the resulting document “on the fly”.

The user should have the option to select this package-supported conversion or to use our support scripts to do this.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/27
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-06-27T10:57:00.276

The preparation of project tarballs produces tar.gz and tar.bz2. The tar.bz2 is not useful anymore, it is supplanted by tar.xz.

(Note that tar.gz is still useful because it provides another tradeoff between size and processing speed.)

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/14
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-04-12T18:01:30.044

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/34
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-08-30T00:02:21.429

We need better quality tests for OCaml. To reach this quality:

• Explicitly map each subfolder of test/ocaml to a use case.
• Improve the number of products tested.
• Use not-that useless toy examples.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/10
• Originally Reported By: Michael Grünewald
• Originally Created At: 2013-10-19T21:58:09.119

List building tests for C libraries and prepare an issue for each of them.

We need to carefully describe the following concepts to achieve a better description and organisation of bsdowl at the project level:

• project, this is the largest unit for the organisation of builds;
• artifact, this is the smallest unit for the organisation of builds;
• library, this is an external dependency to use in the project or in an artifact;
• framework, a glorified library;
• package, a synonymous of project used by the Autoconf tools;
• build configuration;
• build architecture;
• knobs and features.

I am laying out a new project and want to setup a testsuite directory holding our test infrastructure.

I want to define the custom test target in the main project makefile as

test:
    @cd testsuite && ${MAKE} test

but this breaks because bps.subdir.mk unconditionally defines test.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/15
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-04-15T00:16:51.586

The project is moderately complex so it could be useful to make its organisation clearer.

Actions to be taken are not definitively set but here are a few directions:

• Prepare a bird's eyes view of modules and provided functionality, targeted audience
• Review all files and classify them as private if they are for developers or public if they are for end-users
• If appropriate, indicate how to customise public files.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/3
• Originally Reported By: Michael Grünewald
• Originally Created At: 2013-09-21T01:21:50.185

We started bsdowl quite a long time ago — pre Latin Modern era — when PDFs were not the preferred way to render TeX documents, because of the lack of adequate Type 3 fonts. We can accommodate bsdowl to prefer PDFs over DVIs by setting

TEXDEVICE=pdf

in your environment — see the documentation of your shell or Chapter 6 of UNIX Power Tools.

This should be documented in the setup guide. Moreover we could decide to let TEXDEVICE=pdf be the implicit setting in the next major release.

We need some support for the OCaml autoconf macros.

/usr/local/share/aclocal/ocaml.m4

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/9
• Originally Reported By: Michael Grünewald
• Originally Created At: 2013-10-12T17:49:15.627

Documentation is available as a set SGML files used to generate a static website. We want to translate it to markdown because:

• It is easier to write
• It is easier to read, even in raw form
• It is well integrated in the brave new web

This documentation is targeted at users instead of developers. Start with small useful examples and add feature once at a time. Do not stack features, but return to the initial small example (but advertise possible interoperability).

** Project **
Delegating to subdirectories | -
Making clean, distclean and realclean | -
Preparing and signing tarballs | -
Uploading tarballs | -
** Development of scripts ** |
** Preparation of static websites with ONSGMLS ** |
* Development of TeX macros with NOWEB* |
** Maintenance of configuration files ** |

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/1
• Originally Reported By: Michael Grünewald
• Originally Created At: 2013-09-21T00:45:50.788

METAPOST can call TeX to typeset some labels. When this call fails, it may leave some auxiliary files mptextmp.mp and mptextmp.mpx.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/19
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-05-18T10:02:54.741

List building tests for OCaml and prepare an issue for each of them.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/17
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-04-23T06:56:46.926

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/36
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-09-05T17:40:31.849

Compression utilities working with tar are not detected or not supported. The configure script says

checking whether tar -z works...no
checking whether tar -j works...no
checking whether tar -J works...no

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/39
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-09-07T13:43:46.606

Comments lack uniformity in two ways:

• French and English are happily blended together
• Module synopsis, variable description and so on are not consistently formatted

An almost tolerable example is what we might see in

bsdmakepscripts/ocaml/ocaml.odoc.mk

We need to

• Review all files and translate them to English
• Decide how a useful synopsis looks like
• Decide if a more formal description of products and prerequisites could be useful
• Review all files and describe the most important target they define
• Review all files and describe the most important variables they define or use

To keep track of the progress, we add cookies in file headers:

# Cookie: EN SYNOPSIS TARGET VARIABLE

and remove them (one word at a time) when some work on that file is finished. It is thus very easy to track task's progress by grep-awk-ing around.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/2
• Originally Reported By: Michael Grünewald
• Originally Created At: 2013-09-21T01:18:18.263

Currently OCaml program files are suffixed with .cn or .cb while other programs uses different conventions.

It would be interesting to use the same convention as other popular programs, such as ocamlbuild.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/16
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-04-16T09:22:57.571

We want to support several build profiles. A build profile defines a set of compilation options for a project, it should be represented as a Makefile that is included in the main Makefile. Each build profile should configure MAKEOBJDIR according to its name, so that it is easy to switch.

We want to produce packages or ports for the following systems:

• FreeBSD
• Mac OS X (Macports)
• Debian

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/5
• Originally Reported By: Michael Grünewald
• Originally Created At: 2013-10-03T13:59:59.552

The logic of credential switches should be precisely described.

The file misc.dotfiles.mk does not correctly uses this logic on Debian systems and should be corrected.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/22
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-06-06T09:22:23.916

Variables describing the PACKAGE should be available to the whole project. The variables are:

• PACKAGE
• VERSION
• AUTHOR

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/35
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-08-30T00:06:25.309

We need support for standalone METAPOST projects, which do not depend on a LaTeX project. We want to support several naming schemes outputtemplate and output formats outputformat.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/20
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-05-30T17:53:34.954

Debian Wheezy provides version 1.111-3.2 of pmake and not any version of bmake. For users which cannot upgrade to jessie, we need to support our OCaml building chain.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/25
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-06-27T08:58:50.380

List building tests for C programs and prepare an issue for each of them.

We could include the configure script in SCM so that people fetching the source from a tag also get it.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/40
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-09-08T07:28:25.521

When preparing a TeX document including a METAPOST figure, the files listed in MPOST_LIBS appear on the METAPOST command line.

Since the first file, usually the figure file, is likely to say bye, this small error has only a cosmetic impact.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/12
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-03-21T09:09:17.455

The mk-configure software is a replacement for autotools based on bmake. It would be cool that mk-configure users could easily use bsdowl.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/37
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-09-05T21:06:45.843

We need a powerful ocaml.toplevel.mk modules that eases the following tasks:

1. Create a toplevel that automatically adds some paths to the include directories.
2. Create a toplevel that automatically opens some modules.
3. Create a toplevel that automatically install some custom printers.
4. Use the toplevel from other parts of the project, to run tests and scripts.

Points 1, 2 and 3 do not need to be solved purely in ocaml.toplevel.mk but it might be useful to define some cooperation guidelines between the toplevel custom code and ocaml.toplevel.mk.

The toplevel should work identically when it is installed and when it is run inside a developper's subshell (see bps.project.mk).

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/7
• Originally Reported By: Michael Grünewald
• Originally Created At: 2013-10-04T20:21:10.603

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/30
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-08-12T12:45:12.186

Provide some project initiation commands, that can start a project, add modules to the project and handle git hooks or similar functionalities for other VCS systems.

Examples of modules are an OCaml program, an OCaml library, a TeX document, etc.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/21
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-06-02T11:22:02.353

Make's parallel mode (-j) trips over one's foot when building OCaml projects containing lexers and or parsers.

A testcase is test/ocaml/basic:

$ cd test/ocaml/basoc
$ make realclean
$ make depend
$ make build -j 2

make build -j2
ocamlc -c -o main.cmo main.ml
ocamlc -c -o basic_types.cmo basic_types.ml
ocamlc -c -o basic_lexer.cmi basic_lexer.mli
ocamlc -c -o basic_parser.cmi basic_parser.mli
File "basic_lexer.mli", line 1, characters 29-47:
Error: Unbound module Basic_parser
*** [basic_lexer.cmi] Error code 2
1 error
Exit 2

$ cat .depend 
main.cmo :
main.cmx :
basic_types.cmo :
basic_types.cmx :
basic_parser.cmo : basic_types.cmo basic_parser.cmi
basic_parser.cmx : basic_types.cmx basic_parser.cmi
basic_lexer.cmo : basic_parser.cmi basic_lexer.cmi
basic_lexer.cmx : basic_parser.cmx basic_lexer.cmi

Probably, the generation rules in ocaml.yacc.mk or ocaml.lex.mk try to be smarter than they actually are.

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/8
• Originally Reported By: Michael Grünewald
• Originally Created At: 2013-10-04T21:14:02.812

We want to support the preparation of dependency graphs with ocamldoc. Output should be PostScript or PDF.

References

• http://caml.inria.fr/pub/docs/manual-ocaml-400/manual029.html
• http://www.graphviz.org/Documentation.php

• Bitbucket: https://bitbucket.org/michipili/bsdowl/issue/29
• Originally Reported By: Michael Grünewald
• Originally Created At: 2014-08-10T13:18:35.259