Bareos Documentation
  • Introduction and Tutorial
  • Tasks and Concepts
  • Configuration
  • Developer Guide
  • Documentation Style Guide
    • Introduction
    • reST Overview
    • Common Names
    • Specific Formatting
    • Bareos Specific Formatting
      • Document File Structure
      • Bareos Host Names
      • Bareos Configuration
      • Bconsole
      • Bareos Logging
      • Limitation
      • Links
        • Github
        • Download Urls
      • Releases
    • Gotchas
  • Appendix
  • Index
Bareos Documentation
  • Documentation Style Guide
  • Bareos Specific Formatting
  • Links
  • Edit on GitHub

Links

Github

Issue

Refer to a Github Issue by:

* Single issue: :issue:`1780`
* Multiple issues: :issue:`1780,1758`
* Issue of another project: :issue:`drbild/sslpsk#31`

This will be displayed as:

  • Single issue: #1780

  • Multiple issues: #1780, #1758

  • Issue of another project: drbild/sslpsk#31

Pull request

Refer to a Github Pull request by:

* Single pull request: :pr:`160`
* Multiple pull requests: :pr:`150,160`
* Pull request of another project: :pr:`bareos/bareos-contrib#34`

This will be displayed as:

  • Single pull request: #160

  • Multiple pull requests: #150, #160

  • Pull request of another project: bareos/bareos-contrib#34

Commit

Refer to a Github Commit by:

* Commit, full hash: :commit:`a3affbea2047441c19df7cae067b6e47ce030a9a`
* Commit, short hash: :commit:`a3affbe`
* Commit from another project: :commit:`bareos/bareos-contrib@edfa2e19`

This will be displayed as:

  • Commit, full hash: @a3affbe

  • Commit, short hash: @a3affbe

  • Commit from another project: bareos/bareos-contrib@edfa2e1

Download Urls

The role :downloadUrls: expands to the download URL of the current build. It uses variables set in Jenkins for this.

:downloadUrls:`Debian_11/`

For the current build, the output is:

https://download.bareos.org/experimental/pstorz-master-build-windows-in-subdir-of-source/Debian_11/

If only the base release URL should be displayed, use . as parameter:

:downloadUrls:`.`

The output will look like this:

https://download.bareos.org/experimental/pstorz-master-build-windows-in-subdir-of-source/

Previous Next

© Copyright 2025 Bareos GmbH & Co. KG and others.. Revision February 21, 2025.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v:
Versions
Downloads
On Read the Docs
Project Home
Builds