forked from ocaml-batteries-team/batteries-included
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
196 changed files
with
16,981 additions
and
4,703 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,32 @@ | ||
| Look in git log for list of changes | ||
| Look in git log for list of changes. | ||
|
|
||
| The command | ||
|
|
||
| git log --graph --pretty=format:'%Cred%h%Creset -%C(yellow)%d%Creset %s %Cgreen(%cr)%Creset' --abbrev-commit --date=relative | ||
|
|
||
| will print a nice change log showing commit ids like the following: | ||
|
|
||
| * 9d571fc - (HEAD, v1.4.0) Bump version to 1.4.0 (11 minutes ago) | ||
| * 0097761 - Merge in fixes from upstream camomile (8 days ago) | ||
| * a29bb96 - v1.4.0pre2 (tweaks to _oasis) (2 weeks ago) | ||
| * 1c65b81 - (github/v1.4.0) V1.4 iniital commit (2 weeks ago) | ||
| * 8926634 - (github/master) Forgot Bat prefix on substring, compile fix (3 weeks ago) | ||
|
|
||
| The following bash script generates a GNU-style ChangeLog file, if | ||
| that's your thing. | ||
|
|
||
| #!/bin/sh | ||
| # Convert git log to GNU-style ChangeLog file. | ||
| # (C) Chris | ||
| if test -d ".git"; then | ||
| git log --date-order --date=short | \ | ||
| sed -e '/^commit.*$/d' | \ | ||
| awk '/^Author/ {sub(/\\$/,""); getline t; print $0 t; next}; 1' | \ | ||
| sed -e 's/^Author: //g' | \ | ||
| sed -e 's/>Date: \([0-9]*-[0-9]*-[0-9]*\)/>\t\1/g' | \ | ||
| sed -e 's/^\(.*\) \(\)\t\(.*\)/\3 \1 \2/g' > ChangeLog | ||
| exit 0 | ||
| else | ||
| echo "No git repository present." | ||
| exit 1 | ||
| fi |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,76 +1 @@ | ||
| *** Welcome to Batteries Included *** | ||
|
|
||
| OCaml Batteries Included: the community-maintained foundation library | ||
| for your OCaml projects. | ||
|
|
||
|
|
||
| Batteries Included serves the following purposes: | ||
| * define a standard set of libraries which may be | ||
| expected on every compliant installation of OCaml | ||
| * organize these libraries into a hierarchy of modules, | ||
| with one source of documentation | ||
| * provide a consistent API for otherwise independent | ||
| libraries. | ||
|
|
||
| *** Building Batteries Included *** | ||
|
|
||
| **** Requirements **** | ||
| You will need | ||
| * OCaml >= 3.11 | ||
| * Findlib >= 1.2.5 (http://projects.camlcity.org/projects/findlib.html/) | ||
| * make (optional; aids build and installation) | ||
| * Camomile >= 0.7 (http://camomile.sourceforge.net/) | ||
| * OUnit to build and run the tests | ||
|
|
||
| **** Configuration and installation **** | ||
|
|
||
| To install the full version of OCaml Batteries Included, execute | ||
|
|
||
| $ make all | ||
| $ make test [ optional ] | ||
| $ sudo make install | ||
|
|
||
| $ make doc [ optional ] | ||
| $ sudo make install-doc [ optional ] | ||
|
|
||
| If you want the documentation installed elsewhere, set this *before* | ||
| starting the build process (it becomes part of batteries_config.ml). | ||
|
|
||
| $ export DOCROOT=/path/to/new/docroot/ | ||
|
|
||
| If you want findlib to use a -destdir argument to [ocamlfind install], set | ||
|
|
||
| $ export DESTDIR=/path/to/findlib/dest | ||
|
|
||
| To disable native compilation: | ||
|
|
||
| $ export BATTERIES_NATIVE=false | ||
|
|
||
| To disable building of native shared libraries: | ||
|
|
||
| $ export BATTERIES_NATIVE_SHLIB=false | ||
|
|
||
| *** Using Batteries *** | ||
|
|
||
| To get started using Batteries at the toplevel, copy the ocamlinit | ||
| file to ~/.ocamlinit: | ||
|
|
||
| $ cp ocamlinit ~/.ocamlinit | ||
|
|
||
| If you already have findlib in your ~/.ocamlinit, you only need the | ||
| last line in our ocamlinit to load batteries. | ||
|
|
||
| *** ExtLib Compatibility *** | ||
|
|
||
| If your project currently uses ExtLib, most likely you can just change | ||
| [-package extlib] to [-package batteries] and add [open Extlibcompat] | ||
| to the top of any extlib-using modules. Batteries' modules are all | ||
| named BatFoo to differentiate them from extlib's modules, so one can | ||
| use Batteries and ExtLib in the same project. | ||
|
|
||
| COMPATIBILITY NOTE: If you're using ExtLib's Unzip module, it does not | ||
| have a corresponding module in batteries at the moment. | ||
|
|
||
| *** Extending Batteries Included *** | ||
|
|
||
| See doc/batteries/GUIDELINES | ||
| See README.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.