From 599adc0b3f6e74325b616c5c3de66308758359e9 Mon Sep 17 00:00:00 2001 From: Bruno Friedmann Date: Tue, 20 Feb 2024 17:13:00 +0100 Subject: [PATCH 1/4] github issues: introduce templates and workflow - add ISSUE_TEMPLATE/config.yaml - add ISSUE_TEMPLATE/10-issue_report.yaml for bugs - add ISSUE_TEMPLATE/20-feature_request.yaml for feature - add workflows/no-response.yaml no-response action - we don't do line wrap so they will adapt to github rendering page - we use labels of predefined defaults: beside `needs triage`, we prefill with `bug` or `enhancement` as it is easier to remove a label than adding one - we use `render: sh` for log,trace textareas so there's no need to use backtick syntax Signed-off-by: Bruno Friedmann --- .github/ISSUE_TEMPLATE/10-issue_report.yaml | 111 ++++++++++++++++++ .../ISSUE_TEMPLATE/20-feature_request.yaml | 56 +++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 ++ .github/workflows/no-response.yaml | 37 ++++++ 4 files changed, 215 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/10-issue_report.yaml create mode 100644 .github/ISSUE_TEMPLATE/20-feature_request.yaml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/workflows/no-response.yaml diff --git a/.github/ISSUE_TEMPLATE/10-issue_report.yaml b/.github/ISSUE_TEMPLATE/10-issue_report.yaml new file mode 100644 index 00000000000..9b122349618 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/10-issue_report.yaml @@ -0,0 +1,111 @@ +name: Report a Bug +description: | + You found a bug in Bareos causing the application to crash or + throw an exception, a component is buggy, or something looks wrong. +labels: ["bug", "needs triage"] +body: + - type: markdown + attributes: + value: | + Thank you for using Bareos and taking the time to fill out this bug report! + + If you are looking for support, please check out our documentation or consider asking a question on mailing list: + + - https://doc.bareos.org/ + - https://groups.google.com/u/1/g/bareos-users + - type: markdown + attributes: + value: | + Before filling the form fields, please consider the following: + - Ensure that you have searched the [existing issues](https://github.com/bareos/bareos/issues) + - Read the [troubleshooting guide](https://docs.bareos.org/Appendix/Troubleshooting.html) + - Read the [guide to filing a bug](https://docs.bareos.org/Appendix/Troubleshooting.html#bug-reports) + + **What is a bug?** A bug describes an unexpected trouble with the software which + proves a divergence with the documentation, and/or a crash (trace) that are + somewhat reproducible. + + We recommend to discuss your issue on the [mailing list](https://groups.google.com/u/1/g/bareos-users) first. + - type: textarea + id: bareos_version + attributes: + label: Bareos component version + description: Please fill the version of each Bareos component you are seeing the problem on + placeholder: | + 1. bareos-fd --version + 2. bareos-dir --version + 3. bareos-sd --version + 4. bconsole --version + 5. ... `any plugins installed` + validations: + required: true + - type: textarea + attributes: + label: Steps to reproduce + description: Please tell us exactly how to reproduce the problem you are running into. + placeholder: | + 1. ... + 2. ... + + Note: Please try to ensure the bug is reproducible on another system! + + validations: + required: true + - type: textarea + attributes: + label: Expected results + description: Please tell us what is expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Actual results + description: Please tell us what is actually happening. + validations: + required: true + - type: textarea + attributes: + label: Environment + description: | + examples: + - **OS**: _`cat /etc/os-release`_ + - **component**: precise plugin or tools for example, specific filesystem, etc. + value: | + - OS: `` + - component: + render: markdown + validations: + required: false + - type: textarea + id: log + attributes: + label: Relevant log output + description: | + Please include any logs or command output, they will be automatically formatted into code, so no need for backticks. If you are running any `bareos` commands, please include the output of running them with `-d 250 --dt`. For example, the output of running `bconsole -d200 --dt | tee -a /var/tmp/bconsole_debug.log`. + + If the logs are too large to be uploaded to GitHub, you may upload them as a `txt` file or use online tools like https://pastebin.com to share them. + + Note: Please do not upload screenshots of text. Instead, use code blocks or the above mentioned ways to upload logs. + render: shell + - type: textarea + id: trace + attributes: + label: Relevant traces output + description: | + Include the full trace files you will find in your working directory `/var/lib/bareos`. + + While running you may want to increase the debug level of daemon you can refer to [how to setdebug level](https://docs.bareos.org/TasksAndConcepts/BareosConsole.html#bcommandsetdebug) + If the logs are too large to be uploaded to GitHub, you may upload them as a `txt` file or use online tools like https://pastebin.com to share them. + + Note: Please do not upload screenshots of text. Instead, use code blocks or the above mentioned ways to upload traces. + render: shell + - type: textarea + id: supplements + attributes: + label: Anything else? + description: | + Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/20-feature_request.yaml b/.github/ISSUE_TEMPLATE/20-feature_request.yaml new file mode 100644 index 00000000000..f03d6445fe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/20-feature_request.yaml @@ -0,0 +1,56 @@ +name: Feature +description: | + Suggest a new feature for next Bareos +labels: ["enhancement", "needs triage"] +body: + - type: markdown + attributes: + value: | + Thank you for using Bareos! + + If you are looking for support, please check out our documentation or consider asking a question on mailing list: + + - https://doc.bareos.org/ + - https://groups.google.com/u/1/g/bareos-users + - type: markdown + attributes: + value: | + Before filling the form fields, please consider the following: + - Ensure that you have searched the [existing issues](https://github.com/bareos/bareos/issues) + - Read the [troubleshooting guide](https://docs.bareos.org/Appendix/Troubleshooting.html) + - Read the [debugging chapter](https://docs.bareos.org/Appendix/Debugging.html) + - type: textarea + attributes: + label: Use case + description: | + Please tell us the problem you are running into that led to you wanting a new feature. + + Is your feature request related to a problem? Please give a clear and concise description of what the problem is. + + Describe the alternative solutions you've considered. Is there something similar that already solves this? + validations: + required: true + - type: textarea + attributes: + label: Proposal + description: | + Briefly but precisely describe what you would like Bareos to be able to do. + + Consider attaching something showing what you are imagining: + * images + * videos + * code samples + * configuration samples + + Does this have to be provided by Bareos directly, or can it be provided by a package in `bareos/contrib`? If so, maybe consider implementing and publishing such a package rather than filing an issue. + + Please consult our [Developer Guide](https://docs.bareos.org/DeveloperGuide.html) + validations: + required: true + - type: textarea + id: tracking_issues + attributes: + label: Tracking Issues + description: List of issues associated with this feature. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..2a046aa3242 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +--- +blank_issues_enabled: true +contact_links: + - name: Discuss a feature + url: 'https://github.com/bareos/bareos-testing/discussions/new?category=feature' + about: | + Start a discussion about a new feature Bareos should have + - name: Ask a Question + url: 'https://groups.google.com/u/1/g/bareos-users' + about: | + Ask a question about how to use Bareos using google groupe discussions diff --git a/.github/workflows/no-response.yaml b/.github/workflows/no-response.yaml new file mode 100644 index 00000000000..9c7b781a0be --- /dev/null +++ b/.github/workflows/no-response.yaml @@ -0,0 +1,37 @@ +name: No Response + +# Both `issue_comment` and `scheduled` event types are required for this Action +# to work properly. +on: + issue_comment: + types: [created] + schedule: + # Schedule for five minutes after the hour, every 12 hours + - cron: '5 */12 * * *' + +# By specifying the access of one of the scopes, all of those that are not +# specified are set to 'none'. +permissions: + issues: write + +jobs: + noResponse: + runs-on: ubuntu-latest + if: ${{ github.repository == 'bareos/bareos' }} + steps: + - uses: godofredoc/no-response@0ce2dc0e63e1c7d2b87752ceed091f6d32c9df09 + with: + token: ${{ github.token }} + # Comment to post when closing an Issue for lack of response. Set to `false` to disable + closeComment: > + Without additional information, we are unfortunately not sure how to resolve this issue. We are therefore reluctantly going to close this bug for now. + + If you find this problem please file a new issue with the same description, what happens, logs and the output of any command used. + [knowledge base setdebug level](https://docs.bareos.org/TasksAndConcepts/BareosConsole.html#bcommandsetdebug) + All system setups can be slightly different so it's always better to open new issues and reference the related ones. + + Thanks for your contribution. + # Number of days of inactivity before an issue is closed for lack of response. + daysUntilClose: 45 + # Label requiring a response. + responseRequiredLabel: "question" From f999c0dce5736c43a09017e4b09760409d6cf8d0 Mon Sep 17 00:00:00 2001 From: Bruno Friedmann Date: Tue, 19 Mar 2024 11:56:47 +0100 Subject: [PATCH 2/4] docs: introduce github issues in bug database section - reformat long lines - remove contributing patches by email Signed-off-by: Bruno Friedmann --- .../source/DeveloperGuide/generaldevel.rst | 164 ++++++++++++------ 1 file changed, 115 insertions(+), 49 deletions(-) diff --git a/docs/manuals/source/DeveloperGuide/generaldevel.rst b/docs/manuals/source/DeveloperGuide/generaldevel.rst index 031999b393a..f008d345b66 100644 --- a/docs/manuals/source/DeveloperGuide/generaldevel.rst +++ b/docs/manuals/source/DeveloperGuide/generaldevel.rst @@ -36,7 +36,6 @@ Patches Patches should be sent as a pull-request to the master branch of the GitHub repository. A detailed description can be found in the chapter :ref:`git-workflow`. -If you don't want to sign up to GitHub, you can also send us your patches via E-Mail in **git format-patch** format to the `bareos-devel`_ mailing list. Please make sure to use the Bareos `Automatic Sourcecode Formatting`_. Don’t forget any Copyrights and acknowledgments if it isn’t 100% your code. @@ -45,33 +44,46 @@ Also, include the Bareos copyright notice that can be found in every source file Bug Database ------------ -We have a bug database which is at https://bugs.bareos.org/. - +We had an historical bug database located at https://bugs.bareos.org/\ , which is now +in read-only mode. +All new bug are now collected using the `github issues`_ component The first thing is if you want to take over a bug, rather than just make -a note, you should assign the bug to yourself. This helps other +a comment, you should assign the bug to yourself. This helps other developers know that you are the principal person to deal with the bug. -You can do so by going into the bug and clicking on the **Update Issue** -button. Then you simply go to the **Assigned To** box and select your -name from the drop down box. To actually update it you must click on the -**Update Information** button a bit further down on the screen, but if -you have other things to do such as add a Note, you might wait before -clicking on the **Update Information** button. - -Generally, we set the **Status** field to either acknowledged, -confirmed, or feedback when we first start working on the bug. Feedback -is set when we expect that the user should give us more information. - -Normally, once you are reasonably sure that the bug is fixed, and a -patch is made and attached to the bug report, and/or in the Git, you can -close the bug. If you want the user to test the patch, then leave the -bug open, otherwise close it and set **Resolution** to **Fixed**. We -generally close bug reports rather quickly, even without confirmation, +You can do so by going into the issue and use ``assign yourself`` in ``Assignees`` section. + +Working with labels +~~~~~~~~~~~~~~~~~~~ + +Generally, the label ``bug`` and ``need triage`` are already set when a user add an issue. + +The following non exhaustive list, explain what label can be used for sorting and +qualifying the issue. + +- ``bug``: Something isn't working +- ``need triage``: No one has looked at this issue yet +- ``documentation``: Improvements or additions to documentation +- ``duplicate``: This issue or pull request already exists +- ``enhancement``: New feature or request +- ``good first issue``: Good for newcomers +- ``help wanted``: Extra attention is needed +- ``invalid``: This doesn't seem right +- ``question``: Further information is requested +- ``wontfix``: This will not be worked on + +Usually issue related to a PR will be closed when the PR will be merged. +We also have a mechanism that will close any issue still open after a certain days +of non activity. +We generally close bug reports rather quickly, even without confirmation, especially if we have run tests and can see that for us the problem is -fixed. However, in doing so, it avoids misunderstandings if you leave a +fixed or not reproducible. +However, in doing so, it avoids misunderstandings if you leave a note while you are closing the bug that says something to the following -effect: We are closing this bug because... If for some reason, it does -not fix your problem, please feel free to reopen it, or to open a new -bug report describing the problem“. +effect: + + "We are closing this bug because... If for some reason, it does + not fix your problem, please feel free to reopen it, or to open a new + bug report describing the problem“. We do not recommend that you attempt to edit any of the bug notes that have been submitted, nor to delete them or make them private. In fact, @@ -79,66 +91,108 @@ if someone accidentally makes a bug note private, you should ask the reason and if at all possible (with his agreement) make the bug note public. -If the user has not properly filled in most of the important fields (platform, OS, Product Version, ...) please do not hesitate to politely ask him to do so. -The same applies to a support request (we answer only bugs), you might give the user a tip, but please politely refer him to the manual, the `bareos-users`_ mailing list and maybe the `commercial support`_. + +If the user has not properly filled in most of the important fields +(platform, OS, Product Version, ...) please do not hesitate to politely ask him to do so. +The same applies to a support request (we answer only bugs), you might give +the user a tip, but please politely refer him to the manual, the `bareos-users`_ +mailing list and maybe the `commercial support`_. .. _bareos-users: https://groups.google.com/forum/#!forum/bareos-users .. _commercial support: https://www.bareos.com/product/support/ +.. _github issues: https://github.com/bareos/bareos/issues/ + Reporting security issues ~~~~~~~~~~~~~~~~~~~~~~~~~ -If you want to report a security-related problem, please take a look at our `security policy`_. +If you want to report a security-related problem, please take a look +at our `security policy`_. .. _security policy: https://github.com/bareos/bareos/security/policy + Memory Leaks ------------ -Use standard C++17 resource management (RAII and smart pointers) to prevent memory leaks in general. If you need to detect memory leaks, you can just use ``valgrind`` to do so. +Use standard C++17 resource management (RAII and smart pointers) to prevent memory leaks +in general. If you need to detect memory leaks, you can just use ``valgrind`` to do so. + +We also use sanitizers to detect memory leaks. To enable them, ensure you install +``libasan``, ``libubsan``, and ``libtsan`` and then enable sanitizers in the cmake +arguments with ``-DENABLE_SANITIZERS=YES``. -We also use sanitizers to detect memory leaks. To enable them, ensure you install ``libasan``, ``libubsan``, and ``libtsan`` and then enable sanitizers in the cmake arguments with ``-DENABLE_SANITIZERS=YES``. Guiding Principles ------------------ -All new code should be written in modern C++17 following the `Google C++ Style Guide`_ and the `C++ Core Guidelines`_. +All new code should be written in modern C++17 following the `Google C++ Style Guide`_ +and the `C++ Core Guidelines`_. -We like simple rather than complex code, but complex code is still better than complicated code. +We like simple rather than complex code, but complex code is still better than +complicated code. -Currently there is still a lot of old C++ and C code in the code base and a lot of existing code violates our `do's`_ and `don'ts`_. Therefore our long-term goal is to modernize the code-base to make it easier to understand, easier to maintain and better approachable for new developers. +Currently there is still a lot of old C++ and C code in the code base and a lot of +existing code violates our `do's`_ and `don'ts`_. Therefore our long-term goal is to +modernize the code-base to make it easier to understand, easier to maintain and better +approachable for new developers. Boy Scout Rule -------------- -Before submitting your pull request, please ensure that you have followed the Boy Scout Rule: +Before submitting your pull request, please ensure that you have followed +the Boy Scout Rule: > **"Leave the codebase better than you found it."** -The Boy Scout Rule encourages contributors to make small improvements or clean-ups while working on a task without being explicitly requested. By following this rule, we can collectively improve the quality, readability, and maintainability of the codebase over time. +The Boy Scout Rule encourages contributors to make small improvements or clean-ups +while working on a task without being explicitly requested. By following this rule, +we can collectively improve the quality, readability, and maintainability of the +codebase over time. To apply the Boy Scout Rule, consider the following guidelines: -- **Clean up code**: Review the code you are modifying and check if there are any areas that could be improved, such as variable naming, code formatting, or removing unnecessary comments. -- **Refactor when appropriate**: If you find a block of code that you can refactor to improve its clarity or efficiency, take the initiative to make those changes. -- **Fix adjacent issues**: If you notice any related issues or bugs while working on your task, address them if it’s within the scope of your current changes. This proactive approach helps prevent future problems. -- **Update documentation**: If you modify a part of the codebase that affects the existing documentation, ensure that relevant documentation is updated accordingly. +- **Clean up code**: Review the code you are modifying and check if there are any areas + that could be improved, such as variable naming, code formatting, or removing + unnecessary comments. +- **Refactor when appropriate**: If you find a block of code that you can refactor to + improve its clarity or efficiency, take the initiative to make those changes. +- **Fix adjacent issues**: If you notice any related issues or bugs while working on + your task, address them if it’s within the scope of your current changes. + This proactive approach helps prevent future problems. +- **Update documentation**: If you modify a part of the codebase that affects the + existing documentation, ensure that relevant documentation is updated accordingly. + +Remember, the goal of the Boy Scout Rule is to foster continuous improvement and +create a more sustainable and maintainable codebase. By leaving the code better +than you found it, you contribute to the overall health and longevity of the project. -Remember, the goal of the Boy Scout Rule is to foster continuous improvement and create a more sustainable and maintainable codebase. By leaving the code better than you found it, you contribute to the overall health and longevity of the project. Usage of C++ Exceptions ----------------------- -We encourage developers to use C++ exceptions for the reason of simplicity and readability of the code. In contrast to long if/else constructs C++ exceptions are the state-of-the-art error handling mechanism of this programming language. With exceptions it is easier to transport errors and information about errors from the lowest stack level to the uppermost function. +We encourage developers to use C++ exceptions for the reason of simplicity and +readability of the code. In contrast to long if/else constructs C++ exceptions +are the state-of-the-art error handling mechanism of this programming language. +With exceptions it is easier to transport errors and information about errors +from the lowest stack level to the uppermost function. -In order to avoid memory leaks it is very advisable to use RAII or smart pointers for memory allocation. With regard to legacy code it is important to understand how memory management in detail works before throwing exceptions across several stack levels and causing leaks by accident. +In order to avoid memory leaks it is very advisable to use RAII or smart pointers +for memory allocation. With regard to legacy code it is important to understand how +memory management in detail works before throwing exceptions across several stack +levels and causing leaks by accident. + +General advice, many examples and debunked myths about C++ Exceptions can be +found here: https://isocpp.org/wiki/faq/exceptions. -General advice, many examples and debunked myths about C++ Exceptions can be found here: https://isocpp.org/wiki/faq/exceptions. Automatic Sourcecode Formatting ------------------------------- -All C/C++ code should be formatted properly based on the principles mentioned above. Therefore we provide a configuration file for **clang-format** that contains all formatting rules. The filename is ".clang-format" and it is located in the root directory of the bareos repo. +All C/C++ code should be formatted properly based on the principles mentioned above. +Therefore we provide a configuration file for **clang-format** that contains all +formatting rules. The filename is ".clang-format" and it is located in the root +directory of the bareos repo. The configuration file will be automatically found and used by clang-format: @@ -165,7 +219,12 @@ https://github.com/bareos/bareos/blob/master/devtools/pip-tools/README.md descri Formatting exceptions --------------------- -For some parts of code it works best to hand-optimize the formatting. We sometimes do this for larger tables and deeply nested brace initialization. If you need to hand-optimize make sure you add **clang-format off** and **clang-format on** comments so applying **clang-format** on your source will not undo your manual optimization. Please apply common sense and use this exception sparingly. +For some parts of code it works best to hand-optimize the formatting. We sometimes do +this for larger tables and deeply nested brace initialization. If you need to +hand-optimize make sure you add **clang-format off** and **clang-format on** comments +so applying **clang-format** on your source will not undo your manual optimization. +Please apply common sense and use this exception sparingly. + Sourcecode Comments ------------------- @@ -176,13 +235,19 @@ Use ``//`` for single-line comments. SQL queries ----------- -Developers will have to use SQL queries to get data from the database. When you navigate the current code you might get a bit confused as there are different ways to do it: -First, there are direct queries written within the functions that need them. Second, there are functions within the ``cats`` library containing ready made queries that get called. And finally there are the generated SQL files within the ``cats/dml`` folder that get invoked in certain situations. +Developers will have to use SQL queries to get data from the database. When you navigate +the current code you might get a bit confused as there are different ways to do it: +First, there are direct queries written within the functions that need them. Second, +there are functions within the ``cats`` library containing ready made queries that get +called. And finally there are the generated SQL files within the ``cats/dml`` folder +that get invoked in certain situations. Until we decide on a unified way to handle sql queries, we advise the following: -- If your queries are trivial, you can put them as a string within the code you are writing, make sure you wrap them in a function, and make sure it can be reused, -- If you are dealing with long and convoluted queries, write them within the ``cats/dml`` folder and update the related files and enums. +- If your queries are trivial, you can put them as a string within the code you are + writing, make sure you wrap them in a function, and make sure it can be reused, +- If you are dealing with long and convoluted queries, write them within the ``cats/dml`` + folder and update the related files and enums. Do's ---- @@ -231,5 +296,6 @@ avoid the ``edit_*()`` functions from ``edit.cc`` This will also avoid the temporary buffer that is required otherwise. avoid pool memory allocation - The whole allocation library with ``get_pool_memory()`` and friends do not mix with RAII, so we will try to remove them step by step in the future. + The whole allocation library with ``get_pool_memory()`` and friends do not mix with + RAII, so we will try to remove them step by step in the future. Avoid in new code if possible. From eec4cac046ba0dcc0c4a8d576cf4192cb1cdc1de Mon Sep 17 00:00:00 2001 From: Bruno Friedmann Date: Tue, 19 Mar 2024 14:28:16 +0100 Subject: [PATCH 3/4] docs: fix external broken links --- docs/manuals/source/DeveloperGuide/developerFAQ.rst | 2 +- docs/manuals/source/DeveloperGuide/gitworkflow.rst | 2 +- .../source/TasksAndConcepts/NdmpBackupsWithBareos.rst | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/manuals/source/DeveloperGuide/developerFAQ.rst b/docs/manuals/source/DeveloperGuide/developerFAQ.rst index 742d94a94a4..63a44b2d979 100644 --- a/docs/manuals/source/DeveloperGuide/developerFAQ.rst +++ b/docs/manuals/source/DeveloperGuide/developerFAQ.rst @@ -42,7 +42,7 @@ I have changes that affect tapes and autochangers, how can I test them? In order to test tapes, we use :command:`mhvtl` to simulate the presence of tape and autochanger devices. -Documentation is available at https://www.mhvtl.com/ +Documentation is available at https://sites.google.com/site/linuxvtl2/ Some distributions, like openSUSE, offer mhvtl packages that you can download and install using your package manager. Otherwise you need to clone the mhvtl repository from https://github.com/markh794/mhvtl.git. diff --git a/docs/manuals/source/DeveloperGuide/gitworkflow.rst b/docs/manuals/source/DeveloperGuide/gitworkflow.rst index 7277f72c925..0fba80e9c32 100644 --- a/docs/manuals/source/DeveloperGuide/gitworkflow.rst +++ b/docs/manuals/source/DeveloperGuide/gitworkflow.rst @@ -45,7 +45,7 @@ To summarize: * Reviewer: approves the PR and someone from Bareos will merge it. -.. _Github Flow: https://docs.github.com/en/get-started/quickstart/github-flow +.. _Github Flow: https://docs.github.com/en/get-started/using-github/github-flow Releases and Backporting ------------------------ diff --git a/docs/manuals/source/TasksAndConcepts/NdmpBackupsWithBareos.rst b/docs/manuals/source/TasksAndConcepts/NdmpBackupsWithBareos.rst index 6d6d859c140..f10525f8bb0 100644 --- a/docs/manuals/source/TasksAndConcepts/NdmpBackupsWithBareos.rst +++ b/docs/manuals/source/TasksAndConcepts/NdmpBackupsWithBareos.rst @@ -529,7 +529,7 @@ UPDATE Example NDMP Fileset to backup a subset of a NDMP filesystem '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' -The following fileset is intended to backup all files and directories matching :file:`/ifs/home/users/a*`. It has been tested against Isilon OneFS 7.2.0.1. See `Isilon OneFS Administration Guide `_, section quote{NDMP environment variables} for details about the supported NDMP environment variables. Excludes are not used in this example. +The following fileset is intended to backup all files and directories matching :file:`/ifs/home/users/a*`. It has been tested against Isilon OneFS 7.2.0.1. See `Isilon OneFS Administration Guide `_, section quote{NDMP environment variables} for details about the supported NDMP environment variables. Excludes are not used in this example. .. code-block:: bareosconfig :caption: NDMP Fileset Isilon Include/Exclude @@ -737,8 +737,8 @@ Let us have a look what files are in our backup: /ifs/home/admin/.zshrc The real backup data is stored in the file :file:`/@NDMP/ifs/home%0` (we will -refer to it as "NDMP main backup file" or "main backup file" later on). One -NDMP main backup file is created for every directory specified in the used +refer to it as "NDMP main backup file" or "main backup file" later on). One +NDMP main backup file is created for every directory specified in the used Fileset. The other files show the file history and are hard links to the backup file. From 37b9ee327d4ba4ea2b2919d2543f5608a16796c2 Mon Sep 17 00:00:00 2001 From: Bareos Bot Date: Wed, 20 Mar 2024 16:39:44 +0000 Subject: [PATCH 4/4] Update CHANGELOG.md --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index fe7e0fb5091..fadb312306a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -59,6 +59,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Documentation - docs: improvements for droplet, jobdefs [PR #1581] - docs: fix Pool explanation for migration jobs [PR #1728] +- github: introduce template for issues [PR #1716] ### Fixed - dird: fix `purge oldest volume` [PR #1628] @@ -117,6 +118,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 [PR #1708]: https://github.com/bareos/bareos/pull/1708 [PR #1710]: https://github.com/bareos/bareos/pull/1710 [PR #1713]: https://github.com/bareos/bareos/pull/1713 +[PR #1716]: https://github.com/bareos/bareos/pull/1716 [PR #1717]: https://github.com/bareos/bareos/pull/1717 [PR #1718]: https://github.com/bareos/bareos/pull/1718 [PR #1719]: https://github.com/bareos/bareos/pull/1719