Merge pull request #6251 from kit-ty-kate/opamroot-doc

Doc: point users to ways to override the default opam root location in the opam init manpage

master_changes.md

@@ -132,6 +132,7 @@ users)
   * mli documentation: fix code blocks, references, add `@raise` tags [#6150 @rjbou]
   * Unhide `OpamProcess` functions [#6150 @rjbou]
   * Fix a typo in the default man page [#6267 @fccm2]
+  * Point users to ways to override the default opam root location in the opam init manpage [#6251 @kit-ty-kate]
 
 ## Security fixes
 

src/client/opamCommands.ml

@@ -178,7 +178,8 @@ let init cli =
     `P "Initialise the opam state, or update opam init options";
     `P (Printf.sprintf
          "The $(b,init) command initialises a local \"opam root\" (by default, \
-          $(i,~%s.opam%s)) that holds opam's data and packages. This is a \
+          $(i,~%s.opam%s) unless overriden by $(i,--root) or the $(i,OPAMROOT) \
+          environment variable) that holds opam's data and packages. This is a \
           necessary step for normal operation of opam. The initial software \
           repositories are fetched, and an initial 'switch' can also be \
           installed, according to the configuration and options. These can be \