Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

correctly escape parameters with dashes #68281

Merged
merged 1 commit into from
Mar 25, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/docsite/rst/galaxy/dev_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Force
-----

If a directory matching the name of the role already exists in the current working directory, the init command will result in an error. To ignore the error
use the *--force* option. Force will create the above subdirectories and files, replacing anything that matches.
use the ``--force`` option. Force will create the above subdirectories and files, replacing anything that matches.

Container enabled
-----------------
Expand Down Expand Up @@ -120,7 +120,7 @@ When you choose to use your username and password, your password is not sent to
It then sends the token to Galaxy, which in turn verifies that your identity and returns a Galaxy access token. After authentication completes the GitHub token is
destroyed.

If you do not wish to use your GitHub password, or if you have two-factor authentication enabled with GitHub, use the *--github-token* option to pass a personal access token that you create.
If you do not wish to use your GitHub password, or if you have two-factor authentication enabled with GitHub, use the ``--github-token`` option to pass a personal access token that you create.


Import a role
Expand Down Expand Up @@ -154,17 +154,17 @@ By default the command will wait for Galaxy to complete the import process, disp
Branch
^^^^^^

Use the *--branch* option to import a specific branch. If not specified, the default branch for the repo will be used.
Use the ``--branch`` option to import a specific branch. If not specified, the default branch for the repo will be used.

Role name
^^^^^^^^^

By default the name given to the role will be derived from the GitHub repository name. However, you can use the *--role-name* option to override this and set the name.
By default the name given to the role will be derived from the GitHub repository name. However, you can use the ``--role-name`` option to override this and set the name.

No wait
^^^^^^^

If the *--no-wait* option is present, the command will not wait for results. Results of the most recent import for any of your roles is available on the Galaxy web site by visiting *My Imports*.
If the ``--no-wait`` option is present, the command will not wait for results. Results of the most recent import for any of your roles is available on the Galaxy web site by visiting *My Imports*.

Delete a role
-------------
Expand Down Expand Up @@ -210,7 +210,7 @@ To instruct Travis to notify Galaxy when a build completes, add the following to
List Travis integrations
^^^^^^^^^^^^^^^^^^^^^^^^

Use the *--list* option to display your Travis integrations:
Use the ``--list`` option to display your Travis integrations:

.. code-block:: bash

Expand All @@ -226,13 +226,13 @@ Use the *--list* option to display your Travis integrations:
Remove Travis integrations
^^^^^^^^^^^^^^^^^^^^^^^^^^

Use the *--remove* option to disable and remove a Travis integration:
Use the ``--remove`` option to disable and remove a Travis integration:

.. code-block:: bash

$ ansible-galaxy setup --remove ID

Provide the ID of the integration to be disabled. You can find the ID by using the *--list* option.
Provide the ID of the integration to be disabled. You can find the ID by using the ``--list`` option.


.. seealso::
Expand Down