Fix typos (ocaml#3506)

emillon · web-flow · commit 7c77f7f25ad1 · 2020-06-02T14:28:30.000+02:00
* Fix typos (doc)

Signed-off-by: Etienne Millon &lt;me@emillon.org&gt;

* Fix typos (code)

Signed-off-by: Etienne Millon &lt;me@emillon.org&gt;

* Fix typos (tests)

Signed-off-by: Etienne Millon &lt;me@emillon.org&gt;
diff --git a/bin/common.mli b/bin/common.mli
@@ -64,7 +64,7 @@ val display_term : Dune.Config.Display.t option Cmdliner.Term.t
 
 val context_arg : doc:string -> Dune.Context_name.t Cmdliner.Term.t
 
-(** A [--build-info] command line argument that print build informations
+(** A [--build-info] command line argument that print build information
     (included in [term]) *)
 val build_info : unit Cmdliner.Term.t
 
diff --git a/bin/describe.ml b/bin/describe.ml
@@ -102,7 +102,7 @@ end
    arguments of the command line to a list of atoms and we parse it using the
    regular [Dune_lang.Decoder].
 
-   This way we can reuse all the existing versionning, error reporting, etc...
+   This way we can reuse all the existing versioning, error reporting, etc...
    machinery. This also allow to easily extend this to arbitrary complex phrases
    without hassle. *)
 module What = struct
diff --git a/bin/main.ml b/bin/main.ml
@@ -20,7 +20,7 @@ let run_build_command ~common ~targets =
     (* Synchronously wait for the end of the connection with the cache daemon,
        ensuring all dedup messages have been queued. *)
     Caching.Cache.teardown Caching.cache;
-    (* Hande all remaining dedup mesages. *)
+    (* Hande all remaining dedup messages. *)
     Scheduler.wait_for_dune_cache ()
   | None -> ()
 
diff --git a/doc/concepts.rst b/doc/concepts.rst
@@ -663,7 +663,7 @@ The following constructions are available:
 - ``(with-accepted-exit-codes <pred> <DSL>)`` specifies the list of expected exit codes
   for the programs executed in ``<DSL>``. ``<pred>`` is a predicate on integer
   values, and is specified using the :ref:`predicate-lang`. ``<DSL>`` can only
-  contain nested occurences of ``run``, ``bash``, ``system``, ``chdir``,
+  contain nested occurrences of ``run``, ``bash``, ``system``, ``chdir``,
   ``setenv``, ``ignore-<outputs>``, ``with-stdin-from`` and
   ``with-<outputs>-to``. This action is available since dune 2.0.
 - ``(progn <DSL>...)`` to execute several commands in sequence
@@ -1000,7 +1000,7 @@ recommended to use this method in new projects as we expect to deprecate it in
 the future. The right way to define a package is with a ``package`` stanza in
 the ``dune-project`` file.
 
-See :ref:`opam-generation` for intructions on configuring dune to automatically
+See :ref:`opam-generation` for instructions on configuring dune to automatically
 generate ``.opam`` files based on the ``package`` stanzas.
 
 Attaching elements to a package
diff --git a/doc/dune-files.rst b/doc/dune-files.rst
@@ -767,7 +767,7 @@ is ``.dll``.
 
 Up to version 3.0 of the dune language, when ``byte`` is specified but
 none of ``native``, ``exe`` or ``byte_complete`` are specified Dune
-implicitely adds a linking mode that is the same as ``byte_complete``
+implicitly adds a linking mode that is the same as ``byte_complete``
 but using the extension ``.exe``. ``.bc`` files require additional
 files at runtime that are not currently tracked by Dune, so you should
 not run ``.bc`` files during the build. Run the ``.bc.exe`` or
diff --git a/otherlibs/action-plugin/src/dune_action_plugin.mli b/otherlibs/action-plugin/src/dune_action_plugin.mli
@@ -46,7 +46,7 @@ module V1 : sig
   (** {1 Syntax sugar for applicative subset} *)
 
   (** Syntax sugar for applicative subset of the interface. Syntax sugar for
-      [stage] is not provided to prevent accidential use.*)
+      [stage] is not provided to prevent accidental use.*)
   module O : sig
     (** {[ let+ a = g in h ]} is equivalent to {[ map g ~f:(fun a -> g) ]}. *)
     val ( let+ ) : 'a t -> ('a -> 'b) -> 'b t
diff --git a/plugin/jbuild_plugin.mli b/plugin/jbuild_plugin.mli
@@ -6,7 +6,7 @@ module V1 : sig
   (** Current build context *)
   val context : string
 
-  (** OCaml version for the current buid context. It might not be the same as
+  (** OCaml version for the current build context. It might not be the same as
       [Sys.ocaml_version] *)
   val ocaml_version : string
 
diff --git a/src/cache/local.ml b/src/cache/local.ml
@@ -276,7 +276,7 @@ let promote_sync cache paths key metadata ~repository ~duplication =
          this would have a non-negligible performance cost. A good compromise
          seems to be to add a "paranoid" mode to Dune cache where we always
          check file contents for consistency with the expected digest, so one
-         could enable it when needed. In the paranoid mode, we could futhermore
+         could enable it when needed. In the paranoid mode, we could furthermore
          check for a digest collision via [Io.compare_files in_the_cache tmp]. *)
       match Path.exists in_the_cache with
       | true ->
diff --git a/src/cache/local.mli b/src/cache/local.mli
@@ -6,7 +6,7 @@ include Cache
 (** The default root directory of the local cache. *)
 val default_root : unit -> Path.t
 
-(** A matadata file contains a list of [files] produced by a cached build rule,
+(** A metadata file contains a list of [files] produced by a cached build rule,
     along with some [metadata] that can be empty.
 
     One example of what can be included in the [metadata] field is a git commit
diff --git a/src/dune/artifact_substitution.ml b/src/dune/artifact_substitution.ml
@@ -307,7 +307,7 @@ let buf = Bytes.create buf_len
                 |                                                           |
                 |                                                           |
                 v                                                           |
- was the begining of a placeholder found by [Scanner.run]?                  |
+ was the beginning of a placeholder found by [Scanner.run]?                 |
           (i.e. "%%DUNE_PLACEHOLDER:<len>:")                                |
  and if yes, is the whole placeholder currently in [buf]?                   |
         |                                         |                         |
diff --git a/src/dune/assets.ml b/src/dune/assets.ml
@@ -58,7 +58,7 @@ module V1 : sig
   (** Current build context *)
   val context : string
 
-  (** OCaml version for the current buid context. It might not be the same as
+  (** OCaml version for the current build context. It might not be the same as
       [Sys.ocaml_version] *)
   val ocaml_version : string
 
diff --git a/src/dune/build_system.ml b/src/dune/build_system.ml
@@ -1826,7 +1826,7 @@ let package_deps pkg files =
   let rec loop fn acc =
     match Path.as_in_build_dir fn with
     | None ->
-      (* if this file isn't in the build dir, it doesnt belong to any packages
+      (* if this file isn't in the build dir, it doesn't belong to any package
          and it doesn't have dependencies that do *)
       acc
     | Some fn ->
diff --git a/src/dune/command.mli b/src/dune/command.mli
@@ -36,7 +36,7 @@ module Args : sig
 
   (** The type [expand] captures the meaning of a static [Command.Args.t] that
       has no target declarations: it is a way to construct functions that given
-      a current working directory [dir] compute the list of commmand line
+      a current working directory [dir] compute the list of command line
       arguments of type [string list] and a set of dependencies of type
       [Dep.Set.t], or fail. You can use the constructor [Expand] to specify the
       meaning directly, which is sometimes useful, e.g. for memoization. *)
diff --git a/src/dune/context.ml b/src/dune/context.ml
@@ -790,7 +790,7 @@ module Create = struct
 
        - step 3: wait for all instantiation fibers to complete
 
-       If there was a cycle between contexts, the bellow code would dead-lock.
+       If there was a cycle between contexts, the below code would dead-lock.
        However, we check at parsing time that there is no such cycle. *)
     let contexts_map_ivar = Fiber.Ivar.create () in
     let* contexts =
diff --git a/src/dune/coq_lib_name.mli b/src/dune/coq_lib_name.mli
@@ -12,7 +12,7 @@ type t
 (** Returns the wrapper name, a dot-separated list of Coq module identifies *)
 val wrapper : t -> string
 
-(** Returns the directoy name for a lib name, in this case library name foo.bar
+(** Returns the directory name for a lib name, in this case library name foo.bar
     lives in foo/bar *)
 val dir : t -> string
 
diff --git a/src/dune/coq_rules.ml b/src/dune/coq_rules.ml
@@ -41,7 +41,7 @@ let resolve_program sctx ~loc ~dir prog =
 
 module Bootstrap = struct
   (* the internal boot flag determines if the Coq "standard library" is being
-     built, in case we need to explictly tell Coq where the build artifacts are
+     built, in case we need to explitly tell Coq where the build artifacts are
      and add `Init.Prelude.vo` as a dependency; there is a further special case
      when compiling the prelude, in this case we also need to tell Coq not to
      try to load the prelude. *)
diff --git a/src/dune/expander.mli b/src/dune/expander.mli
@@ -2,7 +2,7 @@
     expansion:
 
     1. Static. In this mode it will only expand variables that do not introduce
-    dependncies
+    dependencies
 
     2. Dynamic. In this mode, the expander will record dependencies that are
     introduced by forms it has failed to expand. Later, these dependenceis can
@@ -43,7 +43,7 @@ val set_artifacts_dynamic : t -> bool -> t
 val set_lookup_ml_sources :
   t -> f:(dir:Path.Build.t -> Ml_sources.Artifacts.t) -> t
 
-(** Expander need to expand custom bindings sometimes. For exmaple, the name of
+(** Expander needs to expand custom bindings sometimes. For example, the name of
     the library for the action that runs inline tests. This is the place to add
     such bindings. *)
 val add_bindings : t -> bindings:Pform.Map.t -> t
diff --git a/src/dune/findlib/findlib.ml b/src/dune/findlib/findlib.ml
@@ -325,7 +325,7 @@ end = struct
           (* Here we scan [t.dir] and consider all files named [lib*.ext_lib] to
              be foreign archives, and all other files with the extension
              [ext_lib] to be native archives. The resulting lists of archives
-             will be used to compute appropriate flags for linking dependant
+             will be used to compute appropriate flags for linking dependent
              executables. *)
           match Path.readdir_unsorted t.dir with
           | Error _ ->
diff --git a/src/dune/foreign_sources.ml b/src/dune/foreign_sources.ml
@@ -9,7 +9,7 @@ module Library = Dune_file.Library
    of source files without shoving everything into [Dir_contents].
 
    Furthemore, this module is also responsible for details such as handling file
-   extensions and validing filenames. *)
+   extensions and validating filenames. *)
 type t =
   { libraries : Foreign.Sources.t Lib_name.Map.t
   ; archives : Foreign.Sources.t Foreign.Archive.Name.Map.t
diff --git a/src/dune/lib.ml b/src/dune/lib.ml
@@ -815,7 +815,7 @@ end = struct
               match Map.find acc vlib with
               | None ->
                 (* we've already traversed the virtual library because it must
-                   have occured earlier in the closure *)
+                   have occurred earlier in the closure *)
                 assert false
               | Some (No_impl _) ->
                 loop (Map.set acc vlib (Impl (lib, stack))) libs
diff --git a/src/dune/menhir.ml b/src/dune/menhir.ml
@@ -55,7 +55,7 @@ module Run (P : PARAMS) : sig end = struct
   let sctx = Compilation_context.super_context cctx
 
   (* [build_dir] is the base directory of the context; we run menhir from this
-     directoy to we get correct error paths. *)
+     directory to we get correct error paths. *)
   let build_dir = Super_context.build_dir sctx
 
   let expander = Compilation_context.expander cctx
diff --git a/src/dune/merlin.ml b/src/dune/merlin.ml
@@ -26,7 +26,7 @@ module Preprocess = struct
         (* only No_preprocessing has no loc*)
       in
       warn_dropped_pp loc ~allow_approx_merlin
-        ~reason:"Cannot mix preprocessed and non preprocessed specificiations";
+        ~reason:"Cannot mix preprocessed and non preprocessed specifications";
       Dune_file.Preprocess.No_preprocessing
     | (Future_syntax _ as future_syntax), _
     | _, (Future_syntax _ as future_syntax) ->
diff --git a/src/dune/merlin_server.ml b/src/dune/merlin_server.ml
@@ -67,7 +67,7 @@ module Commands = struct
 end
 
 (* [to_local p] makes absolute path [p] relative to the projects root and
-   optionaly removes the build context *)
+   optionally removes the build context *)
 let to_local abs_file_path =
   let error msg = Error msg in
   let path_opt =
diff --git a/src/dune/module_compilation.ml b/src/dune/module_compilation.ml
@@ -271,10 +271,10 @@ let ocamlc_i ?(flags = []) ~dep_graphs cctx (m : Module.t) ~output =
    exposes a module alias [module X = Foo__X] to all the modules of the `foo`
    library
 
-   The second point is achieved by implicitely openning a module containing such
+   The second point is achieved by implicitly opening a module containing such
    aliases for all modules of `foo` when compiling modules of `foo` via the
    `-open` option of the compiler. This module is called the alias module and is
-   implicitely generated by Dune.*)
+   implicitly generated by Dune.*)
 
 let build_alias_module ~loc ~alias_module ~dir ~cctx =
   let sctx = Compilation_context.super_context cctx in
diff --git a/src/dune/modules.mli b/src/dune/modules.mli
@@ -1,4 +1,4 @@
-(** Module layout information. Contains infromation about aliasing, wrapping. *)
+(** Module layout information. Contains information about aliasing, wrapping. *)
 open Stdune
 
 type t
diff --git a/src/dune/modules_field_evaluator.ml b/src/dune/modules_field_evaluator.ml
@@ -167,7 +167,8 @@ let check_invalid_module_listing ~(buildable : Buildable.t) ~intf_only ~modules
         User_error.raise ~loc (List.concat [ before; [ line_list l ]; after ])
     in
     print
-      [ Pp.text "The folowing modules are implementations of virtual modules:" ]
+      [ Pp.text "The following modules are implementations of virtual modules:"
+      ]
       vmodule_impls_with_own_intf
       [ Pp.text "They cannot have their own interface files." ];
     print
diff --git a/src/dune/modules_field_evaluator.mli b/src/dune/modules_field_evaluator.mli
@@ -1,5 +1,5 @@
-(** The modules field evaluator inteprets the module sources into proper modules
-    in a directroy in the context of a stanza from a dune file. *)
+(** The modules field evaluator interprets the module sources into proper
+    modules in a directory in the context of a stanza from a dune file. *)
 open! Stdune
 
 module Virtual : sig
diff --git a/src/dune/ocaml_stdlib.mli b/src/dune/ocaml_stdlib.mli
@@ -9,7 +9,7 @@ type t = private
   { modules_before_stdlib : Module_name.Set.t
         (** Modules that the Stdlib module depend on. *)
   ; exit_module : Module_name.t option
-        (** Modules that's implicitely added by the compiler at the end when
+        (** Modules that are implicitly added by the compiler at the end when
             linking an executable *)
   ; internal_modules : Glob.t
         (** Module names that are hardcoded in the compiler and so cannot be
diff --git a/src/dune/upgrader.ml b/src/dune/upgrader.ml
@@ -474,7 +474,7 @@ end
 module V2 = struct
   open Common
 
-  (* If no mode is defined, explicitely use the previous default *)
+  (* If no mode is defined, explicitly use the previous default *)
   let explicit_mode fields =
     if Ast_tools.is_in_fields [ "modes" ] fields then
       fields
@@ -690,7 +690,7 @@ let upgrade () =
         Io.write_file (Path.source new_file) contents ~binary:true);
     if !v1_updates && not last then (
       (* Run the upgrader again to update new v1 projects to v2 No more than one
-         additionnal upgrade should be needed *)
+         additional upgrade should be needed *)
       (* We reset thje memoization as a simple way to refresh the File_tree *)
       Memo.reset ();
       aux true
diff --git a/src/dune_lang/decoder.mli b/src/dune_lang/decoder.mli
@@ -103,7 +103,7 @@ type kind =
 
 val kind : (kind, _) parser
 
-(** [repeat t] use [t] to consume all remaning elements of the input until the
+(** [repeat t] uses [t] to consume all remaining elements of the input until the
     end of sequence is reached. *)
 val repeat : 'a t -> 'a list t
 
diff --git a/src/fiber/fiber.ml b/src/fiber/fiber.ml
@@ -18,7 +18,7 @@ module Execution_context : sig
     val run_queue : 'a t Queue.t -> 'a -> unit
   end
 
-  (* Execute a function returning a fiber, passing any raised excetion to the
+  (* Execute a function returning a fiber, passing any raised exception to the
      current execution context. [apply] is guaranteed to not raise. *)
   val apply : ('a -> 'b t) -> 'a -> 'b t
 
diff --git a/src/memo/implicit_output.mli b/src/memo/implicit_output.mli
@@ -8,8 +8,8 @@ val produce : 'o t -> 'o -> unit
 
 val produce_opt : 'o t -> 'o option -> unit
 
-(** [collect*] and [forbid*] take a potentially effectful function (one wich may
-    produce some implicit output) and turn it into a pure one (with explicit
+(** [collect*] and [forbid*] take a potentially effectful function (one which
+    may produce some implicit output) and turn it into a pure one (with explicit
     output if any) *)
 val collect_async : 'o t -> (unit -> 'a Fiber.t) -> ('a * 'o option) Fiber.t
 
diff --git a/src/stdune/path.ml b/src/stdune/path.ml
@@ -1316,7 +1316,7 @@ let temp_dir ?(temp_dir = get_temp_dir_name ()) ?(mode = 0o700) prefix suffix =
   let attempts = 512 in
   let rec loop count =
     if Stdlib.( >= ) count attempts then
-      Code_error.raise "Path.temp_dir: too many failing attemps"
+      Code_error.raise "Path.temp_dir: too many failing attempts"
         [ ("attempts", Int attempts) ]
     else
       let dir =
diff --git a/test/blackbox-tests/test-cases/dune-ppx-driver-system/run.t b/test/blackbox-tests/test-cases/dune-ppx-driver-system/run.t
@@ -84,7 +84,7 @@ Test the argument syntax
   - test_ppx_args.pp.ml
   [1]
 
-Test that going throught the -ppx option of the compiler works
+Test that going through the -ppx option of the compiler works
 
   $ dune build --root driver-tests test_ppx_staged.cma
   Entering directory 'driver-tests'
diff --git a/test/blackbox-tests/test-cases/dune-project-meta/run.t b/test/blackbox-tests/test-cases/dune-project-meta/run.t
@@ -107,7 +107,7 @@ Fatal error with opam file that is not listed in the dune-project file:
   package in your project.
   [1]
 
-Package information fields can be overriden per-package:
+Package information fields can be overridden per-package:
 
   $ mkdir test2
   $ cat >test2/dune-project <<EOF
@@ -370,7 +370,7 @@ generate a dune dependency with a constraint:
   ]
 
 With the dune dependency declared in the dune-project file and version
-of the langauge < 2.6 we don't add the constraint:
+of the language < 2.6 we don't add the constraint:
 
   $ cat > dune-project <<EOF
   > (lang dune 2.5)
@@ -383,7 +383,7 @@ of the langauge < 2.6 we don't add the constraint:
   $ grep ^depends: foo.opam
   depends: ["dune"]
 
-Same with version of the langauge >= 2.6, we now add the constraint:
+Same with version of the language >= 2.6, we now add the constraint:
 
   $ cat > dune-project <<EOF
   > (lang dune 2.6)
diff --git a/test/blackbox-tests/test-cases/env/env-dune-file/run.t b/test/blackbox-tests/test-cases/env/env-dune-file/run.t
@@ -3,13 +3,13 @@ env vars set in env should be visible to all subdirs
   Entering directory 'env-subdir'
   PASS
 
-env vars intepreted in various fields, such as flags
+env vars interpreted in various fields, such as flags
   $ dune build --force --root flag-field
   Entering directory 'flag-field'
   var visible from dune: -principal         foo alias default
   DUNE_FOO: -principal
 
-global vars are overriden
+global vars are overridden
   $ DUNE_FOO=blarg dune build --force --root flag-field
   Entering directory 'flag-field'
   var visible from dune: -principal         foo alias default
diff --git a/test/blackbox-tests/test-cases/foreign-library/run.t b/test/blackbox-tests/test-cases/foreign-library/run.t
@@ -747,7 +747,7 @@ Testsuite for the (foreign_library ...) stanza.
 
 ----------------------------------------------------------------------------------
 * External library directories in (include_dir ...)
-* Build fails when using an uknown library
+* Build fails when using an unknown library
 
   $ cat >some/dir/dune <<EOF
   > (foreign_library
diff --git a/test/blackbox-tests/test-cases/github3043/run.t b/test/blackbox-tests/test-cases/github3043/run.t
@@ -1,6 +1,6 @@
 ----------------------------------------------------------------------------------
 Testsuite for https://github.com/ocaml/dune/issues/3043
-`dune init` should sucessfully create lib or exec projects with library stanza 
+`dune init` should successfully create lib or exec projects with library stanza 
 when --libs option is provided.
 ----------------------------------------------------------------------------------
 
diff --git a/test/blackbox-tests/test-cases/github3046/run.t b/test/blackbox-tests/test-cases/github3046/run.t
diff --git a/test/blackbox-tests/test-cases/merlin/allow_approximate_merlin/run.t b/test/blackbox-tests/test-cases/merlin/allow_approximate_merlin/run.t
diff --git a/test/blackbox-tests/test-cases/variables-for-artifacts/run.t b/test/blackbox-tests/test-cases/variables-for-artifacts/run.t
diff --git a/test/blackbox-tests/test-cases/virtual-libraries/install-file/run.t b/test/blackbox-tests/test-cases/virtual-libraries/install-file/run.t
diff --git a/test/unit-tests/artifact_substitution/artifact_substitution.ml b/test/unit-tests/artifact_substitution/artifact_substitution.ml
