aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKaren Arutyunov <karen@codesynthesis.com>2020-07-14 22:33:56 +0300
committerKaren Arutyunov <karen@codesynthesis.com>2020-07-16 15:48:08 +0300
commite33d6115ee4ea76941d092b72ae06d22415f8e90 (patch)
treecf2545e29ab840570219500477023644426eb952
parent3aa122ed0fd598c4854b3d55f775e06a59112151 (diff)
Documentation tweaks
-rw-r--r--NEWS17
-rw-r--r--bdep/new.cli18
-rwxr-xr-xdoc/cli.sh1
3 files changed, 22 insertions, 14 deletions
diff --git a/NEWS b/NEWS
index 225f894..c7da512 100644
--- a/NEWS
+++ b/NEWS
@@ -1,18 +1,23 @@
Version 0.13.0
* The SPDX License Expression in now the default scheme in the bdep-new
- --type|-t,subdir,license sub-option value. Auto-detected licenses now also
- result in the SPDX License ID in the 'license' manifest value.
+ --type|-t,license sub-option. Auto-detected licenses now also result in
+ the SPDX License ID in the 'license' package manifest value.
- * New --type|-t,subdir bdep-new sub-option for customizing source
- subdirectory. For example:
+ * New source layout customization mechanisms in bdep-new. In particular, the
+ split include/src layout is now supported out of the box:
- $ bdep new -l c++ -t lib,subdir=libhello/io libhello-io
+ $ bdep new -l c++ -t lib,split libhello
- * The bdep-new binless sub-option has been moved from --lang|-l to --type|t.
+ See the SOURCE LAYOUT section in bdep-new(1) for details and a large
+ number of layout examples.
* The bdep-new command now generates the .gitattributes file.
+ * The bdep-new --subdirectory mode option has been renamed to --source.
+
+ * The bdep-new binless sub-option has been moved from --lang|-l to --type|t.
+
Version 0.12.0
* Support for creating new projects with existing files.
diff --git a/bdep/new.cli b/bdep/new.cli
index 3508465..2ae24de 100644
--- a/bdep/new.cli
+++ b/bdep/new.cli
@@ -278,7 +278,7 @@ namespace bdep
The project type can be specified with the \c{\b{--type}|\b{-t}} option.
The \cb{empty} project type is language-agnostic with the semantics and
- valid sub-options for the rest being language-dependant, as described
+ valid sub-options for the rest being language-dependent, as described
next. If unspecified, an executable project is created by default.
\dl|
@@ -795,10 +795,12 @@ namespace bdep
Note that while the same physical layout can be achieved with various
combinations of source prefix and subdirectory, there will be differences
in semantics since the headers in the project are included with the source
- subdirectory (if any) as a prefix.
+ subdirectory (if any) as a prefix. See \l{intro#proj-struct Canonical
+ Project Structure} for details.
As we have already seen, the source subdirectory can be customized with the
- \cb{subdir} project type sub-option. For example:
+ \cb{subdir} project type sub-option. For example (pass \cb{-l\ c++,cpp} for
+ the \cb{.hpp}/\cb{.cpp} naming scheme):
\
# libhello/hello/
@@ -941,11 +943,11 @@ namespace bdep
$ tree libhello/
libhello/
└── src/
- ├── hello/
- │   └── hello.cxx
- └── include/
- └── hello/
- └── hello.hxx
+ ├── include/
+ │   └── hello/
+ │   └── hello.hxx
+ └── hello/
+ └── hello.cxx
\
A similar layout but without the source subdirectory in \c{src/}:
diff --git a/doc/cli.sh b/doc/cli.sh
index 44886aa..3c93ac1 100755
--- a/doc/cli.sh
+++ b/doc/cli.sh
@@ -53,6 +53,7 @@ function compile ()
--link-regex '%bpkg(#.+)?%../../bpkg/doc/build2-package-manager-manual.xhtml$1%' \
--link-regex '%brep(#.+)?%../../brep/doc/build2-repository-interface-manual.xhtml$1%' \
--link-regex '%bdep(#.+)?%build2-project-manager-manual.xhtml$1%' \
+--link-regex '%intro(#.+)?%../../build2-toolchain/doc/build2-toolchain-intro.xhtml$1%' \
../bdep/$n.cli
cli -I .. \