Fix typos

This commit is contained in:
Anton Bachin 2017-06-17 12:06:58 -04:00
parent 832bd631c2
commit 63b63eb0ac
4 changed files with 15 additions and 15 deletions

View File

@ -70,9 +70,9 @@ a binary OCaml AST in ``<output-file>``.
Additionally, it is expected that if the executable is invoked with Additionally, it is expected that if the executable is invoked with
``--as-ppx`` as its first argument, then it will behave as a standard ``--as-ppx`` as its first argument, then it will behave as a standard
ppx rewirter as passed to ``-ppx`` option of OCaml. This is for two ppx rewirter as passed to ``-ppx`` option of OCaml. This is for two
reason: reasons:
- to improve interoperability with build systems that Jbuilder - to improve interoperability with build systems other than Jbuilder
- so that it can be used with merlin - so that it can be used with merlin
Findlib integration and limitations Findlib integration and limitations

View File

@ -13,9 +13,9 @@ hundred of developers, which means that it is highly tested and
productive. productive.
When using Jbuilder, you give very little and high-level information to When using Jbuilder, you give very little and high-level information to
the build system, which in turns takes care of all the low-level the build system, which in turn takes care of all the low-level
details, from the compilation of your libraries, executables and details, from the compilation of your libraries, executables and
documentation to the installation, setting up of tests, setting up of documentation, to the installation, setting up of tests, setting up of
the development tools such as merlin, etc. the development tools such as merlin, etc.
In addition to the normal features one would expect from a build system In addition to the normal features one would expect from a build system
@ -23,14 +23,14 @@ for OCaml, Jbuilder provides a few additional ones that detach it from
the crowd: the crowd:
- you never need to tell Jbuilder where things such as libraries are. - you never need to tell Jbuilder where things such as libraries are.
Jbuilder will always discover it automatically. In particular this Jbuilder will always discover them automatically. In particular, this
mean that when you want to re-organize your project you need to do no means that when you want to re-organize your project you need to do no
more than rename your directories, Jbuilder will do the rest more than rename your directories, Jbuilder will do the rest
- things always work the same whether your dependencies are local or - things always work the same whether your dependencies are local or
installed on the system. In particular this mean that you can always installed on the system. In particular, this means that you can always
drop in the source for a dependency of your project in your working drop in the source for a dependency of your project in your working
copy and Jbuilder will start using immediately. This makes Jbuilder a copy and Jbuilder will start using it immediately. This makes Jbuilder a
great choice for multi-project development great choice for multi-project development
- cross-platform: as long as your code is portable, Jbuilder will be - cross-platform: as long as your code is portable, Jbuilder will be

View File

@ -31,10 +31,10 @@ The exact specification of S-expressions is described in the
documentation of the `parsexp <https://github.com/janestreet/parsexp>`__ documentation of the `parsexp <https://github.com/janestreet/parsexp>`__
library. library.
In a nutshell, the syntax is as follow: In a nutshell, the syntax is as follows:
- atoms that do no contain special characters are simply written as - atoms that do no contain special characters are simply written as
it. For instance: ``foo``, ``bar`` are valid atomic S-expressions is. For instance: ``foo``, ``bar`` are valid atomic S-expressions
- atoms containing special characters or spaces must be quoted using - atoms containing special characters or spaces must be quoted using
the syntax ``"..."``: ``"foo bar\n"`` the syntax ``"..."``: ``"foo bar\n"``
@ -68,15 +68,15 @@ everything that is installable in a workspace, run at the root:
$ jbuilder build @install $ jbuilder build @install
Declaring a package this way will allow you to add elements such as Declaring a package this way will allow you to add elements such as
libraries, executables, documentations, ... to your package by declaring libraries, executables, documentation, ... to your package by declaring
them in ``jbuild`` files. them in ``jbuild`` files.
Such elements can only be declared in the scope defined by the Such elements can only be declared in the scope defined by the
corresponding ``<package>.opam`` file. Typically your corresponding ``<package>.opam`` file. Typically, your
``<package>.opam`` files should be at the root of your project, since ``<package>.opam`` files should be at the root of your project, since
this is where ``opam pin ...`` will look for them. this is where ``opam pin ...`` will look for them.
Note that ``<package>`` must be non empty, so in particular ``.opam`` Note that ``<package>`` must be non-empty, so in particular ``.opam``
files are ignored. files are ignored.
.. _scopes: .. _scopes:
@ -133,7 +133,7 @@ conventions and automatically installs any README\*, CHANGE\*, HISTORY\*
and LICENSE\* files in the same directory as the ``<package>.opam`` file and LICENSE\* files in the same directory as the ``<package>.opam`` file
to a location where odig will find them. to a location where odig will find them.
Note that this include files present in the source tree as well as Note that this includes files present in the source tree as well as
generated files. So for instance a changelog generated by a user rule generated files. So for instance a changelog generated by a user rule
will be automatically installed as well. will be automatically installed as well.

View File

@ -29,7 +29,7 @@ Terminology
visible. Private items include libraries or binaries that will not visible. Private items include libraries or binaries that will not
be installed. In Jbuilder, scopes are sub-trees rooted where at be installed. In Jbuilder, scopes are sub-trees rooted where at
least one ``<package>.opam`` file is present. Moreover, scopes are least one ``<package>.opam`` file is present. Moreover, scopes are
exclusive. Typically every project defines a single scope. See exclusive. Typically, every project defines a single scope. See
:ref:`scopes` for more details :ref:`scopes` for more details
- **build context**: a build context is a subdirectory of the - **build context**: a build context is a subdirectory of the