Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/src/commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ build

.. program:: build

This will build a package, but it doesn't install it. This is useful over using raw cmake as it will use the cmake toolchain that was initialized by cget which sets cmake up to easily find the dependencies that have been installed by cget. This will also install the dependencies in a ``dev-requirements.txt`` file if available, otherwise it will install any dependencies in the ``requirements.txt``.
This will build a package, but it doesn't install it. This is useful over using raw cmake as it will use the cmake toolchain that was initialized by cget which sets cmake up to easily find the dependencies that have been installed by cget. This will also install the dependencies in a ``dev-requirements.cget`` file if available, otherwise it will install any dependencies in the ``requirements.cget``.

.. option:: <package-source>

Expand Down Expand Up @@ -186,7 +186,7 @@ However, ``cget`` will always create the build directory out of source. The ``cg

.. option:: <package-source>

This specifies the package source (see :ref:`pkg-src`) that will be installed. If no package source is provided then ``cget`` will default to using the ``requirements.txt`` file or the ``dev-requirements.txt`` file if available. That is ``cget install`` is equivalent to ``cget install -f requirements.txt`` or ``cget install -f dev-requirements.txt``.
This specifies the package source (see :ref:`pkg-src`) that will be installed. If no package source is provided then ``cget`` will default to using the ``requirements.cget`` file or the ``dev-requirements.cget`` file if available. That is ``cget install`` is equivalent to ``cget install -f requirements.cget`` or ``cget install -f dev-requirements.cget``.

.. option:: -p, --prefix PATH

Expand Down
8 changes: 4 additions & 4 deletions docs/src/recipe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
Using recipes
=============

Many times a package doesn't list its dependencies in a requirements.txt file, or it requires special defines or custom cmake(see :ref:`custom-cmake`). A recipe helps simplify this, by allowing a package to be installed with a simple recipe name without needing to update the original package source.
Many times a package doesn't list its dependencies in a requirements.cget file, or it requires special defines or custom cmake(see :ref:`custom-cmake`). A recipe helps simplify this, by allowing a package to be installed with a simple recipe name without needing to update the original package source.

---------------------
Structure of a recipe
---------------------

A recipe is a directory which contains a 'package.txt' file and an optional 'requirements.txt' file. If a 'requirements.txt' is not provided, then the requirements file in the package will be used otherwise the requirements file in the recipe will be used and the package's requirements.txt will be ignored.
A recipe is a directory which contains a 'package.txt' file and an optional 'requirements.cget' file. If a 'requirements.cget' is not provided, then the requirements file in the package will be used otherwise the requirements file in the recipe will be used and the package's requirements.cget will be ignored.

Both files follow the format describe in :any:`requirements`. The 'package.txt' file list only one package, which is the package to be installed. The 'requirements.txt' list packages to be installed as dependencies, which can also reference other recipes.
Both files follow the format describe in :any:`requirements`. The 'package.txt' file list only one package, which is the package to be installed. The 'requirements.cget' list packages to be installed as dependencies, which can also reference other recipes.

All recipe directories are searched under the ``$CGET_PREFIX/etc/cget/recipes/`` directory. A cmake package can install additional recipes through cget.

Expand All @@ -22,7 +22,7 @@ We can now install zlib with just ``cget install zlib``. Additionally, we can se

http://downloads.sourceforge.net/project/boost/boost/1.62.0/boost_1_62_0.tar.bz2 --cmake boost

We can also make zlib a dependency of boost by writing a ``$CGET_PREFIX/etc/cget/recipes/boost/requirements.txt`` file listing zlib::
We can also make zlib a dependency of boost by writing a ``$CGET_PREFIX/etc/cget/recipes/boost/requirements.cget`` file listing zlib::

zlib

Expand Down
6 changes: 3 additions & 3 deletions docs/src/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
Requirements file
=================

.. program:: requirements.txt
.. program:: requirements.cget

``cget`` will install all packages listed in the top-level ``requirements.txt`` file in the package. Each requirement is listed on a new line.
``cget`` will install all packages listed in the top-level ``requirements.cget`` file in the package. Each requirement is listed on a new line.

.. option:: <package-source>

Expand Down Expand Up @@ -36,5 +36,5 @@ This specifies the package source (see :ref:`pkg-src`) that will be installed.

.. option:: --ignore-requirements

This will ignore the requirement.txt file in the project. This is useful when a package has a requirements.txt file that is actually for python packages, not cget.
This will ignore the requirements.cget file in the project. This is useful when a package has a requirements.txt file that is actually for python packages, not cget.

Loading