Remove make-dylan-app, document dylan-tool

dylan-tool has now subsumed all make-dylan-app functionality. This is a
_minimal_ replacement of make-dylan-app, but before #1457 is fixed, the Getting
Started with CLI docs should be updated to recommend using dylan-tool in
general, rather than git submodules.

Author: cgay

BUILDING.rst

@@ -70,7 +70,7 @@ back-end.
 Building
 --------
 
-To build ``dylan-compiler``, ``make-dylan-app``, and several tools::
+To build :program:`dylan-compiler` and several tools::
 
   export PATH=$(dirname $(which dylan-compiler)):$PATH
   ./autogen.sh
@@ -98,11 +98,11 @@ can point it in the right direction by using ``--with-gc``::
 
   ./configure --prefix=/opt/opendylan-current --with-gc=/path/to/boehm
 
-By default, this will build a fully bootstrapped compiler with the
-first generation in ``Bootstrap.1/bin/dylan-compiler``, the second
-generation in ``Bootstrap.2/bin/dylan-compiler``, and the third in
-``Bootstrap.3/bin/dylan-compiler``. The third generation will then be
-installed as ``/opt/opendylan-current/bin/dylan-compiler``.
+By default, this will build a fully bootstrapped compiler with the first
+generation in :file:`Bootstrap.1/bin/dylan-compiler`, the second generation in
+:file:`Bootstrap.2/bin/dylan-compiler`, and the third in
+:file:`Bootstrap.3/bin/dylan-compiler`. The third generation will then be
+installed as :file:`/opt/opendylan-current/bin/dylan-compiler`.
 
 Running Tests
 -------------
@@ -113,7 +113,10 @@ complete::
   make check
 
 This runs the tests for the core language implementation as well as for many
-bundled libraries.
+bundled libraries. You may also want to run the
+``dfmc-environment-test-suite``, with ::
+
+  make check-environment
 
 Windows
 =======
@@ -135,7 +138,7 @@ Windows
 
 * Please keep in mind that paths with whitespaces are not well supported.
 
-* cd into build\\windows and run::
+* cd into :file:`build\\windows` and run::
 
     build-release.bat <target-dir> /sources <git-checkout>\sources /internal
 
@@ -147,7 +150,7 @@ IDE in <target-dir>.
   * Get NSIS from http://nsis.sf.net and the HTML help workshop (from
     Microsoft, to generate the chm).
 
-  * Go to packages\\win32-nsis, read Build.txt and follow the
-    instructions. Make sure you are using the same command shell as
-    used for building Open Dylan (to retain environment variables).
+  * Go to :file:`packages\\win32-nsis`, read :file:`Build.txt` and follow the
+    instructions. Make sure you are using the same command shell as used for
+    building Open Dylan (to retain environment variables).
 

Makefile.in

@@ -189,7 +189,7 @@ cli2:
 BOOTSTRAP_3_ROOT = $(abs_builddir)/Bootstrap.3
 
 BOOTSTRAP_3_LIBRARIES = \
-	dylan-compiler dylan-environment parser-compiler dswank make-dylan-app
+	dylan-compiler dylan-environment parser-compiler dswank
 BOOTSTRAP_3_STATICS = \
 	dylan-tool
 

README.md

@@ -16,9 +16,9 @@ Verify that the downloaded version is working correctly by building a
 hello-world binary:
 
   ```
-  make-dylan-app hello-world
+  dylan new application --simple hello-world
   cd hello-world
-  dylan-compiler -build hello-world
+  dylan build --all
   _build/bin/hello-world
   ```
 

build/windows/Makefile

@@ -302,7 +302,7 @@ SIMPLE_DAYTIME_CLIENT_SOURCE = $(NETWORK_EXAMPLES_SOURCE)\simple-daytime-client
 SIMPLE_DAYTIME_CLIENT_INSTALL_DIRECTORY = $(NETWORK_EXAMPLES_INSTALL_DIRECTORY)\simple-daytime-client
 SIMPLE_DAYTIME_SERVER_SOURCE = $(NETWORK_EXAMPLES_SOURCE)\simple-daytime-server
 SIMPLE_DAYTIME_SERVER_INSTALL_DIRECTORY = $(NETWORK_EXAMPLES_INSTALL_DIRECTORY)\simple-daytime-server
-MAKE_DYLAN_APP_SOURCE = $(APP_DIRECTORY)\make-dylan-app
+DYLAN_TOOL_SOURCE = $(APP_DIRECTORY)\dylan-tool
 
 #
 # CORBA projects
@@ -381,7 +381,7 @@ PARSER_COMPILER = $(INSTALL_BIN_DIRECTORY)\parser-compiler.exe
 TESTWORKS_REPORT = $(INSTALL_BIN_DIRECTORY)\testworks-report.exe
 WIN32_ENVIRONMENT = $(INSTALL_BIN_DIRECTORY)\win32-environment.exe
 WITH_SPLASH_SCREEN = $(INSTALL_BIN_DIRECTORY)\with-splash-screen.exe
-MAKE_DYLAN_APP = $(INSTALL_BIN_DIRECTORY)\make-dylan-app.exe
+DYLAN_TOOL = $(INSTALL_BIN_DIRECTORY)\dylan-tool.exe
 
 BIG_INTEGERS_DLL = $(RUNTIME_PREFIX)bigint
 CHANNELS_DLL = $(RUNTIME_PREFIX)chnnls
@@ -754,7 +754,7 @@ devel-dbg-ui: $(DEVEL_DBG_UI)
 dll-wrap: $(DLL_WRAP)
 parser-compiler: $(PARSER_COMPILER)
 testworks-report: $(TESTWORKS_REPORT)
-make-dylan-app: $(MAKE_DYLAN_APP)
+dylan-tool: $(DYLAN_TOOL)
 
 project-manager-libraries: tools-interface user-projects
 core-compiler-libraries: file-source-records release-info dood binary-manager coff-manager binary-builder coff-builder build-system parser-run-time dfmc-management dfmc-browser-support project-manager-libraries dfmc-debug-back-end
@@ -1073,7 +1073,7 @@ rel-environment: dylan-environment win32-environment with-splash-screen
 libraries: user-libraries win32-libraries duim ole-libraries duim-ole database-libraries network dylan-orb naming-client midi
 example-projects: console-example-projects duim-example-projects win32-example-projects ole-example-projects duim-ole-example-projects network-example-projects corba-example-projects
 install-examples: install-examples-css install-console-examples install-duim-examples install-win32-examples install-basic-doc-examples install-templates install-database-examples install-ole-examples install-duim-ole-examples install-network-examples install-corba-examples install-enhanced-doc-examples install-midi-examples
-tools: install-wdbgdylan dll-wrap dylan-playground gui-dylan-playground create-id console-scepter naming-service remote-debugger testworks-libraries debugger parser-compiler make-dylan-app
+tools: install-wdbgdylan dll-wrap dylan-playground gui-dylan-playground create-id console-scepter naming-service remote-debugger testworks-libraries debugger parser-compiler dylan-tool
 release: release-info dylan-compiler-with-tools compiler environment rel-environment libraries tools install-runtime-dlls install-examples
 
 reinstall-examples:
@@ -2000,13 +2000,13 @@ $(TESTWORKS_REPORT):
   $(ENSURE_SOURCES) testworks-report $(TESTWORKS_REPORT_SOURCE)
   $(BUILD_APPLICATION) testworks-report
 
-$(MAKE_DYLAN_APP):
+$(DYLAN_TOOL):
   $(ENSURE_RUNTIME_LIBRARY) $(COMMON_DYLAN_DLL) common-dylan
   $(ENSURE_RUNTIME_LIBRARY) $(IO_DLL) io
   $(ENSURE_RUNTIME_LIBRARY) $(SYSTEM_DLL) system
   $(ENSURE_RUNTIME_LIBRARY) $(STRINGS_DLL) strings
-  $(ENSURE_SOURCES) make-dylan-app $(MAKE_DYLAN_APP_SOURCE)
-  $(BUILD_APPLICATION) make-dylan-app
+  $(ENSURE_SOURCES) dylan-tool $(DYLAN_TOOL_SOURCE)
+  $(BUILD_APPLICATION) dylan-tool
 
 # Test Suites
 

documentation/getting-started-cli/source/dylan-mode-for-emacs.rst

@@ -27,8 +27,8 @@ you put dylan-mode.  ::
 Setting ``OPEN_DYLAN_USER_REGISTRIES`` is important because that's how
 DIME finds your projects.
 
-For this tutorial let's use a "dime-test" project created with
-``make-dylan-app``.  See the section :doc:`hello-world` to create the
+For this tutorial let's use a "dime-test" project created with the
+``dylan`` tool.  See the section :doc:`hello-world` to create the
 project, and also make sure you have a registry entry for it.  See
 :doc:`source-registries` if you're not sure how to set that up.
 
@@ -37,7 +37,7 @@ project, and also make sure you have a registry entry for it.  See
     $ export PATH=/opt/opendylan/bin:$PATH
     $ cd ...dir containing registry...
     $ echo abstract://dylan/dime-test/dime-test.lid > registry/generic/dime-test
-    $ make-dylan-app dime-test
+    $ dylan new application --simple dime-test
     $ cd dime-test
     $ emacs dime-test.dylan
     M-x dime <Enter>

documentation/getting-started-cli/source/hello-world.rst

@@ -6,52 +6,56 @@ how do you write the canonical Hello World app?  This example assumes the
 ``bash`` shell is used.  You may need to adjust for your local shell.  ::
 
   $ export PATH=/opt/opendylan/bin:$PATH
-  $ make-dylan-app hello-world
+  $ dylan new application --simple hello-world
   $ cd hello-world
   $ dylan-compiler -build hello-world.lid
   ...lots of output...
   $ _build/bin/hello-world
   Hello, world!
 
-Ta da!  Now a quick review of the steps with a little bit of
-explanation.
+Ta da!  Now a quick review of the steps with a little bit of explanation.
 
-First you must set ``PATH`` so that ``make-dylan-app`` and
-``dylan-compiler`` will be found.  ``./_build/bin`` is where
-dylan-compiler puts the executables it builds.
+First you must set ``PATH`` so that the :program:`dylan` and
+:program:`dylan-compiler` commands will be found.  ``./_build/bin`` is where
+:program:`dylan-compiler` puts the executables it builds.
 
 .. note:: Some of these differ on Windows, so please be sure
    to read :doc:`windows` if you are on Windows.
    :class: alert alert-block alert-warning
 
-``make-dylan-app`` creates a directory with the same name as the
-project, and four files:
+:program:`dylan` creates a directory with the same name as the project, and
+several files:
 
-1. ``hello-world.lid`` -- This says what other files are part of the project.
-   The order in which the files are listed here determines the order in which
-   the code in them is executed.
+1. :file:`hello-world.lid` -- This says what other files are part of the
+   project.  The order in which the files are listed here determines the order
+   in which the code in them is executed.
 
-2. ``library.dylan`` contains the library and module definitions.  These can be
-   extended as your project grows more complex.
+2. :file:`library.dylan` contains the library and module definitions.  These
+   can be extended as your project grows more complex.
 
-3. ``hello-world.dylan`` contains the main program. Note that the last
+3. :file:`hello-world.dylan` contains the main program. Note that the last
    top-level definition is a call to the main function, which may have any
    name; there is no predefined "main" function that is automatically called.
 
-4. ``registry/<platform>/hello-world`` is a "registry file", which contains the
-   path to the ``hello-world.lid`` file.
+4. :file:`registry/{platform}/hello-world` is a "registry file", which contains
+   the path to the :file:`hello-world.lid` file.
+
+5. :file:`dylan-package.json` is a JSON file that describes the package you're
+   working on, in this case "hello-world". This is where you can specify
+   dependencies, the package location, etc. See the `dylan-tool documentation
+   <https://docs.opendylan.org/packages/dylan-tool/documentation/source/index.html>`_
+   for more on this.
 
 The first time you build ``hello-world`` it builds all used libraries, all the
 way down to the ``dylan`` library itself.  Subsequent compiles only need to
 recompile ``hello-world`` itself and are therefore much faster.
 
-``dylan-compiler`` has a batch mode and an interactive mode.  The ``-build``
-option says to build the project in batch mode.  When you pass a ".lid" file to
-the compiler it builds the library described by that file.  In the next section
-you'll see that you can also pass the name of the project (without ".lid") and
-it will use "registries" to find the project sources.
+:program:`dylan-compiler` has a batch mode and an interactive mode.  The
+``-build`` option says to build the project in batch mode.  When you pass a
+".lid" file to the compiler it builds the library described by that file.  In
+the next section you'll see that you can also pass the name of the project
+(without ".lid") and it will use "registries" to find the project sources.
 
-The compiler places its output in the ``_build`` directory in the
-current working directory. This includes the libraries and executables
-that it builds.  You can run the executable as noted above from this
-location.
+The compiler places its output in the ``_build`` directory in the current
+working directory. This includes the libraries and executables that it builds.
+You can run the executable from this location, as noted above.

documentation/getting-started-cli/source/index.rst

@@ -10,7 +10,7 @@ the Open Dylan IDE
 <https://opendylan.org/documentation/getting-started-ide/>`_.
 
 The compiler executable is called ``dylan-compiler``.  There is a helper
-application called ``make-dylan-app``, which can be used to generate some
+application called :program:`dylan`, which can be used to generate some
 boilerplate for a new project, and finally there's ``DIME`` and ``dswank``, a
 pair of tools for interactive development in Emacs.  This document describes
 these tools.

documentation/getting-started-cli/source/source-registries.rst

@@ -1,24 +1,24 @@
 Using Source Registries
 =======================
 
-Passing the name of a ".lid" file to ``dylan-compiler`` works great when you
-have a single library that only uses other libraries that are part of Open
+Passing the name of a ".lid" file to :program:`dylan-compiler` works great when
+you have a single library that only uses other libraries that are part of Open
 Dylan, but what if you want to use a second library that you wrote yourself or
-that you installed from GitHub?  How will ``dylan-compiler`` find the sources
-for that library?  The answer is registries.  For each Dylan library that isn't
-part of Open Dylan itself, you create a file in the registry that points to the
-".lid" file for the library.  For example, here's the registry file for
-hello-world, created in the previous section. Note that this assumes you are
-still in the directory created by ``make-dylan-app``::
-
-  $ cat ./registry/generic/hello-world
+that you installed from GitHub?  How will :program:`dylan-compiler` find the
+sources for that library?  The answer is registries.  For each Dylan library
+that isn't part of Open Dylan itself, you create a file in the registry that
+points to the ".lid" file for the library.  For example, here's the registry
+file for hello-world, created in the previous section. Note that this assumes
+you are still in the directory created by :command:`dylan new application`::
+
+  $ cat ./registry/{platform}/hello-world   # substitute your platform
   abstract://dylan/hello-world.lid
 
 What's going on here?  First of all, the registry mechanism makes it possible
-to have platform specific libraries.  Anything platform-independent (like our
-hello-world example) goes under the "generic" directory.  Other supported
-platform names are ``x86_64-freebsd``, ``x86_64-linux``, ``x86-win32``,
-etc. For a full list see `the Open Dylan registry
+to have platform-specific libraries.  Anything platform-independent can go
+under the :file:`generic` directory.  Other supported platform names are
+``x86_64-freebsd``, ``x86_64-linux``, ``x86-win32``, etc. For a full list see
+`the Open Dylan registry
 <https://github.com/dylan-lang/opendylan/tree/master/sources/registry>`_.
 
 Platform-specific registry directories are searched before the
@@ -31,30 +31,30 @@ Now let's look at the actual content of our hello-world registry file::
   abstract://dylan/hello-world.lid
 
 What this is doing is locating a file *relative to the directory containing the
-registry directory itself*.  If the "registry" directory is
+registry directory itself*.  If the :file:`registry` directory is
 ``/home/you/xyz/registry`` then ``abstract://dylan/hello-world.lid`` says the
 hello-world ".lid" file is in ``/home/you/xyz/hello-world.lid``.
 "abstract://dylan/" is just boilerplate.
 
-When you invoke ``dylan-compiler`` in the directory **containing** the
+When you invoke :program:`dylan-compiler` in the directory containing the
 "registry" directory it automatically uses that registry, in addition to (and
 taking precedence over) the registry in the Open Dylan installation directory.
 
 If you prefer to invoke the compiler from elsewhere, you can set the
-``OPEN_DYLAN_USER_REGISTRIES`` environment variable to point your registry
-directory. For example::
+:envvar:`OPEN_DYLAN_USER_REGISTRIES` environment variable to point your
+registry directory. For example::
 
   $ export OPEN_DYLAN_USER_REGISTRIES=/home/you/xyz/registry
 
-Once you've set ``OPEN_DYLAN_USER_REGISTRIES`` to your new registry,
-``dylan-compiler`` can find the hello-world library source no matter what
-directory you're currently working in. You only need to specify the library
-name::
+Once you've set :envvar:`OPEN_DYLAN_USER_REGISTRIES` to your new registry,
+:program:`dylan-compiler` can find the hello-world library source no matter
+what directory you're currently working in. You only need to specify the
+library name::
 
   $ cd /tmp
   $ dylan-compiler -build hello-world
 
-You can add more than one registry to ``OPEN_DYLAN_USER_REGISTRIES`` by
+You can add more than one registry to :envvar:`OPEN_DYLAN_USER_REGISTRIES` by
 separating them with colons (Unix) or semicolons (Windows)::
 
   $ export OPEN_DYLAN_USER_REGISTRIES=/my/registry:/their/registry

documentation/man-pages/source/conf.py

@@ -218,7 +218,7 @@
 man_pages = [
     ('dylan-compiler', 'dylan-compiler', u'Dylan Compiler',
      [u'Dylan Hackers'], 1),
-    ('make-dylan-app', 'make-dylan-app', u'Simple Dylan project generator',
+    ('dylan', 'dylan', u'Dylan workspace/package management tool',
      [u'Dylan Hackers'], 1)
 ]
 

documentation/man-pages/source/dylan-compiler.rst

@@ -25,12 +25,10 @@ The following options are among those available:
 
 See ``dylan-compiler -help`` for a full listing of the options.
 
-See the *Open Dylan Console Environment* section of the *Getting
-Started* guide for more details on the usage of the ``dylan-compiler``
-command line tool.
+See https://opendylan.org/documentation/getting-started-cli/ for more
+details on the usage of the ``dylan-compiler`` command line tool.
 
 SEE ALSO
 ========
 
-``make-dylan-app(1)``
-
+``dylan(1)``

documentation/man-pages/source/dylan.rst

@@ -0,0 +1,22 @@
+=====
+dylan
+=====
+
+SYNOPSIS
+========
+
+::
+
+  dylan [global options] subcommand... [options] args...
+
+DESCRIPTION
+===========
+
+``dylan`` is a tool to create and maintain Dylan packages and invoke the
+Dylan compiler.
+
+
+SEE ALSO
+========
+
+``dylan-compiler(1)``

documentation/man-pages/source/index.rst

@@ -12,7 +12,7 @@ Contents:
    :maxdepth: 2
 
    dylan-compiler
-   make-dylan-app
+   dylan
 
 
 Indices and tables