diff --git a/doc/advanced-topics.rst b/doc/advanced-topics.rst index f36f4fa3..45440bff 100644 --- a/doc/advanced-topics.rst +++ b/doc/advanced-topics.rst @@ -70,9 +70,9 @@ a binary OCaml AST in ````. Additionally, it is expected that if the executable is invoked with ``--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 -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 Findlib integration and limitations diff --git a/doc/overview.rst b/doc/overview.rst index a586dc3c..bf3a0a80 100644 --- a/doc/overview.rst +++ b/doc/overview.rst @@ -13,9 +13,9 @@ hundred of developers, which means that it is highly tested and productive. 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 -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. 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: - you never need to tell Jbuilder where things such as libraries are. - Jbuilder will always discover it automatically. In particular this - mean that when you want to re-organize your project you need to do no + Jbuilder will always discover them automatically. In particular, this + 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 - 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 - 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 - cross-platform: as long as your code is portable, Jbuilder will be diff --git a/doc/project-layout-specification.rst b/doc/project-layout-specification.rst index 2a68a0b9..90378060 100644 --- a/doc/project-layout-specification.rst +++ b/doc/project-layout-specification.rst @@ -31,10 +31,10 @@ The exact specification of S-expressions is described in the documentation of the `parsexp `__ 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 - 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 the syntax ``"..."``: ``"foo bar\n"`` @@ -68,15 +68,15 @@ everything that is installable in a workspace, run at the root: $ jbuilder build @install 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. Such elements can only be declared in the scope defined by the -corresponding ``.opam`` file. Typically your +corresponding ``.opam`` file. Typically, your ``.opam`` files should be at the root of your project, since this is where ``opam pin ...`` will look for them. -Note that ```` must be non empty, so in particular ``.opam`` +Note that ```` must be non-empty, so in particular ``.opam`` files are ignored. .. _scopes: @@ -133,7 +133,7 @@ conventions and automatically installs any README\*, CHANGE\*, HISTORY\* and LICENSE\* files in the same directory as the ``.opam`` file 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 will be automatically installed as well. diff --git a/doc/terminology.rst b/doc/terminology.rst index 6216ffc8..0e724950 100644 --- a/doc/terminology.rst +++ b/doc/terminology.rst @@ -29,7 +29,7 @@ Terminology visible. Private items include libraries or binaries that will not be installed. In Jbuilder, scopes are sub-trees rooted where at least one ``.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 - **build context**: a build context is a subdirectory of the