Skip to content

Commit a9a8c48

Browse files
committed
fixing a few more issues pointed out by v
1 parent c78f038 commit a9a8c48

3 files changed

Lines changed: 10 additions & 10 deletions

File tree

pages/docs/user-docs/action-build.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ folder: docs
66
toc: false
77
---
88

9-
`build` is the "Swiss army knife" of container creation. You can use it to download and assemble existing containers from external resources like [Singularity Hub](https://singularity-hub.org/) and [Docker Hub](https://hub.docker.com/). You can use it to convert containers between the various formats supported by Singularity. And you can use it in conjunction with a [Singularity Recipe](/docs-recipes) file to create a container from scratch and customized it to fit your needs.
9+
`build` is the "Swiss army knife" of container creation. You can use it to download and assemble existing containers from external resources like [Singularity Hub](https://singularity-hub.org/) and [Docker Hub](https://hub.docker.com/). You can use it to convert containers between the various formats supported by Singularity. And you can use it in conjunction with a [Singularity recipe](/docs-recipes) file to create a container from scratch and customized it to fit your needs.
1010

1111
{% include toc.html %}
1212

@@ -20,7 +20,7 @@ The target defines the method that `build` uses to create the container. It can
2020
- path to a **existing container** on your local machine
2121
- path to a **directory** to build from a sandbox
2222
- path to an **archive** in .tar or compressed .tar.gz format
23-
- path to a **[Recipe file](docs-recipes)**
23+
- path to a **[Singularity recipe file](docs-recipes)**
2424

2525
In addition `build` can produce containers in three different formats. Formats types can be specified by passing the following options to build.
2626

@@ -111,12 +111,12 @@ $ singularty build production2 development/
111111
```
112112
You can convert the three supported container formats using any combination.
113113

114-
Use care when converting writable ext3 images or sandbox directories to the default squashfs file format. If changes were made to the writable container before conversion, there is no record of those changes in the Recipe file rendering your container non-reproducible. It is a best practice to build your immutable production containers directly from a Recipe file instead.
114+
Use care when converting writable ext3 images or sandbox directories to the default squashfs file format. If changes were made to the writable container before conversion, there is no record of those changes in the Singularity recipe file rendering your container non-reproducible. It is a best practice to build your immutable production containers directly from a Singularity recipe file instead.
115115

116-
## Building containers from Recipe files
117-
Of course, Recipe files can be used as the target when building a container. For detailed information on writing Recipe files, please see [the Container Recipes docs](docs-recipes).
116+
## Building containers from Singularit recipe files
117+
Of course, Singularity recipe files can be used as the target when building a container. For detailed information on writing Singularity recipe files, please see [the Container Recipes docs](docs-recipes).
118118

119-
Let's say you already have the following Recipe file called `Singularity`, and you want to use it to build a container.
119+
Let's say you already have the following container recipe file called `Singularity`, and you want to use it to build a container.
120120

121121
```
122122
BootStrap: docker
@@ -150,13 +150,13 @@ By default if you build into an existing container, the `build` command will ski
150150
Use care with this option: you may get results that you did not expect.
151151

152152
### `--section`
153-
If you only want to build a single section of your Recipe file use the `--section` option. For instance, if you have edited the `%environment` section of a long Recipe and don't want to completely re-build the container, you could re-build only the `%environment` section like so:
153+
If you only want to build a single section of your Singularity recipe file use the `--section` option. For instance, if you have edited the `%environment` section of a long Singularity recipe and don't want to completely re-build the container, you could re-build only the `%environment` section like so:
154154

155155
```
156156
$ sudo singularity build --section environment image.simg Singularity
157157
```
158158

159-
Under normal build conditions, the Recipe file is saved into a container's meta-data so that there is a record showing how the container was built. Using the `--section` option may render this meta-data useless, so use care if you value reproducibility.
159+
Under normal build conditions, the Singularity recipe file is saved into a container's meta-data so that there is a record showing how the container was built. Using the `--section` option may render this meta-data useless, so use care if you value reproducibility.
160160

161161
### `--notest`
162162
If you don't want to run the `%test` section during the container build, you can skip it with the `--notest` option. For instance, maybe you are building a container intended to run in a production environment with GPUs. But perhaps your local build resource does not have GPUs. You want to include a `%test` section that runs a short validation but you don't want your build to exit with an error because it cannot find a GPU on your system.

pages/docs/user-docs/docs-environment-metadata.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ If you build a container from Singularity Hub or Docker Hub, the environment wil
1616

1717
```
1818
Bootstrap: shub
19-
From: singularityhub/ubuntu
19+
From: vsoch/hello-world
2020
2121
%environment
2222
VARIABLE_NAME=VARIABLE_VALUE

pages/docs/user-docs/docs-recipes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ For example, a very minimal Singularity Hub build might look like this:
3131

3232
```
3333
Bootstrap: shub
34-
From: singularityhub:ubuntu
34+
From: vsoch/hello-world
3535
```
3636

3737
A build that uses a mirror to install Centos-7 might look like this:

0 commit comments

Comments
 (0)