zhangyiss/spack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update to documentation formatting.

Browse Source
This commit is contained in:
citibeth 2016-03-27 00:14:10 -04:00
parent a1c965d70d
commit 4a6b5d5247
1 changed files with 24 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

45
lib/spack/docs/packaging_guide.rst
View File

@ -1773,7 +1773,7 @@ discover its dependencies.
If you want to see the environment that a package will build with, or If you want to see the environment that a package will build with, or
if you want to run commands in that environment to test them out, you if you want to run commands in that environment to test them out, you
can use the :ref:```spack env`` <spack-env>` command, documented can use the :ref:`spack env <spack-env>` command, documented
below. below.
.. _compiler-wrappers: .. _compiler-wrappers:
@ -1812,7 +1812,7 @@ An example of this would be the ``libdwarf`` build, which has one
dependency: ``libelf``. Every call to ``cc`` in the ``libdwarf`` dependency: ``libelf``. Every call to ``cc`` in the ``libdwarf``
build will have ``-I$LIBELF_PREFIX/include``, build will have ``-I$LIBELF_PREFIX/include``,
``-L$LIBELF_PREFIX/lib``, and ``-Wl,-rpath,$LIBELF_PREFIX/lib`` ``-L$LIBELF_PREFIX/lib``, and ``-Wl,-rpath,$LIBELF_PREFIX/lib``
inserted on the command line. This is done transparently to the ‰ command line. This is done transparently to the
project's build system, which will just think it's using a system project's build system, which will just think it's using a system
where ``libelf`` is readily available. Because of this, you **do where ``libelf`` is readily available. Because of this, you **do
not** have to insert extra ``-I``, ``-L``, etc. on the command line. not** have to insert extra ``-I``, ``-L``, etc. on the command line.
@ -2722,12 +2722,12 @@ example:
.. code-block:: bash .. code-block:: bash
> cd myproject cd myproject
> spack spconfig myproject@local spack spconfig myproject@local
> mkdir build; cd build mkdir build; cd build
> ../spconfig.py .. ../spconfig.py ..
> make make
> make install make install
Notes: Notes:
* Spack must have ``myproject/package.py`` in its repository for * Spack must have ``myproject/package.py`` in its repository for
@ -2749,6 +2749,7 @@ Notes:
reference of what dependencies are being used. reference of what dependencies are being used.
* ``make install`` installs the package into the Spack repository, * ``make install`` installs the package into the Spack repository,
where it may be used by other Spack packages. where it may be used by other Spack packages.
* CMake-generated makefiles re-run CMake in some circumstances. Use of ``spconfig.py`` breaks this behavior, requiring the developer to manually re-run ``spconfig.py`` when a ``CMakeLists.txt`` file has changed.
CMakePackage CMakePackage
~~~~~~~~~~~~ ~~~~~~~~~~~~
@ -2764,6 +2765,7 @@ a dict) to provide to the ``cmake`` command. Usually, these will
translate variant flags into CMake definitions. For example: translate variant flags into CMake definitions. For example:
.. code-block:: python .. code-block:: python
def configure_args(self): def configure_args(self):
spec = self.spec spec = self.spec
return [ return [
@ -2785,19 +2787,20 @@ superclass, which breaks down the standard ``Package.install()``
method into several sub-stages: ``spconfig``, ``configure``, ``build`` method into several sub-stages: ``spconfig``, ``configure``, ``build``
and ``install``. Details: and ``install``. Details:
* Instead of implementing the standard ``install()`` method, package * Instead of implementing the standard ``install()`` method, package
authors implement the methods for the sub-stages authors implement the methods for the sub-stages
``install_spconfig()``, ``install_configure()``, ``install_spconfig()``, ``install_configure()``,
``install_build()``, and ``install_install()``. ``install_build()``, and ``install_install()``.
* The ``spack install`` command runs the sub-stages ``configure``,
``build`` and ``install`` in order. (The ``spconfig`` stage is * The ``spack install`` command runs the sub-stages ``configure``,
not run by default; see below). ``build`` and ``install`` in order. (The ``spconfig`` stage is
* The ``spack spconfig`` command runs the sub-stages ``spconfig`` not run by default; see below).
and a dummy install (to create the module file). * The ``spack spconfig`` command runs the sub-stages ``spconfig``
* The sub-stage install methods take no arguments (other than and a dummy install (to create the module file).
``self``). The arguments ``spec`` and ``prefix`` to the standard * The sub-stage install methods take no arguments (other than
``install()`` method may be accessed via ``self.spec`` and ``self``). The arguments ``spec`` and ``prefix`` to the standard
``self.prefix``. ``install()`` method may be accessed via ``self.spec`` and
``self.prefix``.
GNU Autotools GNU Autotools
~~~~~~~~~~~~~ ~~~~~~~~~~~~~