Skip to content

Commit

Permalink
doc: more dylan-tool -> deft changes (#1583)
Browse files Browse the repository at this point in the history
  • Loading branch information
cgay authored Apr 29, 2024
2 parents 2a1b646 + aa536b1 commit b4aa2f9
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 25 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ Verify that the downloaded version is working correctly by building a
hello-world binary:

```
dylan new application --simple hello-world
deft new application --simple hello-world
cd hello-world
dylan build --all
deft build --all
_build/bin/hello-world
```

Expand Down
19 changes: 9 additions & 10 deletions documentation/getting-started-cli/source/managing-dependencies.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,12 @@ Managing Dependencies
=====================

We recommend managing inter-library dependencies by use of the Dylan package
manager and the :program:`dylan` tool. When using the :program:`dylan` tool
dependencies are added to the "dylan-package.json" file in your project. Each
dependency includes a `semantic version <https://semver.org>`_ and `dependency
resolution
<https://opendylan.org/package/dylan-tool/pacman.html#dependency-resolution>`_
is done with "minimal version selection". See the `dylan-tool`_ documentation
for details.
manager and :program:`deft`. When using :program:`deft` dependencies are added
to the "dylan-package.json" file in your project. Each dependency includes a
`semantic version <https://semver.org>`_ and `dependency resolution
<https://opendylan.org/package/deft/pacman.html#dependency-resolution>`_ is
done with "minimal version selection". See the `deft`_ documentation for
details.

The second way to manage dependencies is to use Git submodules. The remainder
of this document explains how to do that.
Expand Down Expand Up @@ -70,8 +69,8 @@ Transitive Dependencies
-----------------------

The Dylan compiler won't find transitive dependencies automatically (unless you
are using `dylan-tool`_), so you will need to create registry entries for them
as well.
are using `deft`_), so you will need to create registry entries for them as
well.

Sometimes, you will want to create git submodules for them as
well, but other times you can just reference them from the
Expand All @@ -82,4 +81,4 @@ a number of submodules, so you don't need to pull each
of those in directly, but can reference them through
the ``ext/http/`` directory.

.. _dylan-tool: https://opendylan.org/package/dylan-tool/index.html
.. _deft: https://opendylan.org/package/deft/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ For further details of the LID file format, see :doc:`../library-reference/lid`.
4) The ``Platforms`` keyword

Platform-specific LID files should use the ``Platforms`` keyword to indicate
which platforms they apply to. This tells the `dylan update
<https://opendylan.org/package/dylan-tool/index.html#dylan-update>`_
command which registry files to create.
which platforms they apply to. This tells the `deft update
<https://opendylan.org/package/deft/index.html#deft-update>`_ command which
registry files to create.

=============== ========================= =========================
Keyword unix-io.lid win32-io.lid
Expand Down
20 changes: 10 additions & 10 deletions documentation/getting-started-cli/source/source-registries.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Using Source Registries
=======================

.. note:: When using the :program:`dylan` tool source registries are created
for you via the `dylan update
<https://opendylan.org/package/dylan-tool/index.html#dylan-update>`_
command and you should not have to create them explicitly. You may
want to skip this section for now.
.. note:: When using :program:`deft`, source registries are created for you via
the `deft update
<https://opendylan.org/package/deft/index.html#deft-update>`_ command
and you should not have to create them explicitly. You may want to
skip this section for now.

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
Expand All @@ -17,18 +17,18 @@ For each Dylan library that isn't part of Open Dylan itself, you create a file
in the registry which is named the same as the library and contains a pointer
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 `dylan new application
<https://opendylan.org/package/dylan-tool/index.html#dylan-new-application>`_.
still in the directory created by `deft new application
<https://opendylan.org/package/deft/index.html#deft-new-application>`_.

::

$ ls registry/*/hello-world
registry/x86_64-darwin/hello-world

What's going on here? First of all, the registry mechanism makes it possible
to have platform-specific libraries. The `dylan
<https://opendylan.org/package/dylan-tool/index.html>`_ tool currently always
writes registry entries to a platform-specific directory, in this case
to have platform-specific libraries. `deft
<https://opendylan.org/package/deft/index.html>`_ currently always writes
registry entries to a platform-specific directory, in this case
``x86_64-darwin``, but anything platform-independent can actually go in the
:file:`registry/generic` subdirectory.

Expand Down

0 comments on commit b4aa2f9

Please sign in to comment.