Commit d7559745 authored by Tristan Gingold's avatar Tristan Gingold

doc: minor fixes.

parent 0ab5685a
......@@ -23,7 +23,7 @@ hdlmake.dep_file module
:show-inheritance:
hdlmake.new_dep_solver module
-------------------------
-----------------------------
.. automodule:: hdlmake.new_dep_solver
:members:
......
......@@ -220,7 +220,7 @@ As a developer, you may wish to avoid installing ``hdlmake`` directly into your
.. code-block:: bash
cd /path_to_hdlmake_sources/hdl-make
python2.7 setup.py develop
pip install --user -e .
Alternatively, you may choose to forgo installing anything in your Python environment and simply directly run from the source by creating a launch script.
Create a launch script in /usr/bin or any other available location at shell $PATH. You can name the script as you prefer so, by doing this, multiple ``hdlmake`` versions can easily be used in the same machine. In any case, in this documentation we will consider that the name for this launch script is just ``hdlmake``.
......@@ -246,7 +246,20 @@ In the above examples the following nomenclature is used:
Windows specific guidelines
---------------------------
From the new 3.0 version onwards, ``hdlmake`` supports execution on native ``Windows`` shell, including both the old ``cmd`` and the new ``PowerShell``. In this section, you'll find instructions on how to install and configure the tool and the required versions of the programs (``Git`` and ``Make``).
As ``hdlmake`` uses ``Make``, the installation on Windows is slightly tricky.
First you have to install ``Make``. But there are two flavours of ``Make``:
the native one (which uses ``cmd`` or ``PowerShell``) and the cygwin one (which
uses ``bash``).
The commands used are not the same. For example to remove a file, ``del`` is
used with the native flavour but ``rm`` is used for ``bash``. The tool
``hdlmake`` chooses the flavour according to the python executable. So
you have to use a matching pair of ``Python`` and ``Make``: either both
native or both cygwin.
In any case, you also need to install ``Git``.
The instructions below are for the native flavour.
Make
~~~~
......@@ -1645,7 +1658,7 @@ As an example, this command will generate the Makefile and will try to print ``H
``-s, --suffix ARBITRARY_CODE``
------------------------------
-------------------------------
Add arbitrary Python code from the command line that **will be evaluated after each Manifest.py** parse action across the hierarchy.
As an example, this command will generate the Makefile but will try to print ``Bye, bye hdlmake`` after each ``Manifest.py`` run:
......@@ -1653,4 +1666,3 @@ As an example, this command will generate the Makefile but will try to print ``B
.. code-block:: bash
hdlmake -s "print('Bye, bye hdlmake')" makefile
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment