Skip to content

In ssh_keys docs, add -q option to ssh-add to make it quiet

A. I. Oleynikov requested to merge (removed):quiet-ssh-add into master

What does this MR do?

Uses -q option for ssh-add instead of stdout redirect on the following page: https://docs.gitlab.com/ce/ci/ssh_keys/.

When you add a key, ssh-add actually writes to stderr, so > /dev/null doesn't work here. Either stderr redirect should be used or the -q option. The latter is available since OpenSSH portable version 7.9, present on Debian Buster, Ubuntu Disco, etc. It is better than 2>/dev/null, because it won't suppress actual errors.

At the bottom of the page there is a link to an example SSH project, I've sent a similar MR there.

Related issues

gitlab-examples/ssh-private-key#15 (closed)

Author's checklist

  • Follow the Documentation Guidelines and Style Guide.
  • Link docs to and from the higher-level index page, plus other related docs where helpful.
  • Apply the ~Documentation label.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set and that you merge the equivalent EE MR before the CE MR if both exist.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.
Edited by A. I. Oleynikov

Merge request reports