feat: Add deprecation warnings and documentation

[uristdwarf]

Add warnings for deprecations that will be removed in 5.0.0.
Also fix some documentation issues for the man files.

[gemini-code-assist]

Hello @uristdwarf, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request addresses two main issues: deprecation warnings and documentation improvements. It adds warnings for features that will be removed in version 5.0.0, giving users advance notice. Additionally, it fixes documentation issues in the man pages to improve clarity and accuracy.

Highlights

• Deprecation Warnings: Adds safs::log_warn messages to the master code to warn about deprecated emptytrash, emptyreserved, setgoal, and settrashtime operations in changelogs, as well as XOR goals in goal configs. Also adds warnings to tools like file_info, recursive_remove, set_goal, set_trashtime, and snapshot when the -l option is used, indicating it will become the default behavior. A warning is also added to sfsmount when the sfscachefiles option is used.
• Documentation Updates: Updates man pages for saunafs-fileinfo, saunafs-getgoal, saunafs-gettrashtime, saunafs-makesnapshot, saunafs-rremove, sfschunkserver, sfsmaster, sfsmetalogger, and sfsmount to reflect deprecations and clarify option usage.
• Tooling: The sfstools.sh script now emits a warning that it is deprecated and that the saunafs command should be used instead.

Changelog

Click here to see the changelog

• doc/saunafs-fileinfo.1.adoc
  • Added documentation for the -l option, noting its deprecation and future default status.
• doc/saunafs-getgoal.1.adoc
  • Added documentation for the -l option, noting its deprecation and future default status.
  • Documented the deprecation of rgetgoal and rsetgoal aliases.
• doc/saunafs-gettrashtime.1.adoc
  • Added documentation for the -l option, noting its deprecation and future default status.
  • Documented the deprecation of rgettrashtime and rsettrashtime aliases.
• doc/saunafs-makesnapshot.1.adoc
  • Added documentation for the -l option, noting its deprecation and future default status.
• doc/saunafs-rremove.1.adoc
  • Added documentation for the -l option, noting its deprecation and future default status.
• doc/sfschunkserver.8.adoc
  • Removed deprecated -f and -s options from the synopsis and description.
• doc/sfsmaster.8.adoc
  • Removed deprecated -f and -s options from the synopsis and description.
• doc/sfsmetalogger.8.adoc
  • Removed deprecated -f option from the synopsis.
• doc/sfsmount.1.adoc
  • Documented the deprecation of the -o sfscachefiles option.
  • Fixed a typo in the description of sfslognotificationarea and sfsmessagesuppressionperiod.
• src/common/goal.h
  • Added <algorithm> include
  • Added isXor() method to the Goal class to check for XOR slices.
• src/master/goal_config_loader.cc
  • Added a warning message when XOR goals are detected in the goals config file.
• src/master/restore.cc
  • Added warning messages for deprecated emptytrash, emptyreserved, setgoal, and settrashtime operations used in changelogs.
• src/mount/fuse/mount_config.cc
  • Added a warning message when the sfscachefiles mount option is used.
• src/tools/file_info.cc
  • Updated usage message to indicate the -l option will be default in 5.0.0.
  • Added a warning message when the -l option is used.
• src/tools/main.cc
  • Added a warning message when deprecated tool names (rgetgoal, rsetgoal, rgettrashtime, rsettrashtime) are used.
• src/tools/recursive_remove.cc
  • Updated usage message to indicate the -l option will be default in 5.0.0.
  • Added a warning message when the -l option is used.
  • Fixed an issue where trailing slashes were not being removed from the input path on Windows.
• src/tools/set_goal.cc
  • Updated usage message to indicate the -l option will be default in 5.0.0.
  • Added a warning message when the -l option is used.
• src/tools/set_trashtime.cc
  • Updated usage message to indicate the -l option will be default in 5.0.0.
  • Added a warning message when the -l option is used.
  • Added <common/massert.h> include.
• src/tools/sfstools.sh
  • Added a warning message to indicate the script is deprecated and that the saunafs command should be used instead.
• src/tools/snapshot.cc
  • Updated usage message to indicate the -l option will be default in 5.0.0.
  • Added a warning message when the -l option is used.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

---

Did you know?

The SaunaFS project name might be inspired by the Finnish word 'sauna', referring to a traditional Finnish bath. This could be a playful reference to cleaning and maintaining the file system, similar to how a sauna cleanses the body.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request adds deprecation warnings and documentation updates for features that will be removed in version 5.0.0. The changes are well-structured and provide helpful information to users about the upcoming changes. However, there are a few areas where the messaging and implementation could be improved to ensure clarity and consistency.

Summary of Findings

• Inconsistent deprecation warning messages: The deprecation warning messages are not consistent across all files. Some messages mention that the feature will be removed in 5.0.0, while others do not. Consistency in messaging is important for a good user experience.
• Placement of deprecation warnings: The deprecation warnings for the -l option are placed within the if (long_wait) block. This means that the warning is only shown when the -l option is used. It would be better to show the warning regardless of whether the option is used, as the option itself is deprecated.
• Missing deprecation warning in sfstools.sh: The sfstools.sh script is deprecated, but there is no mention of using saunafs instead. This could lead to confusion for users who are not aware of the change.
• Inaccurate deprecation message for rgettrashtime and rsettrashtime: The deprecation message for rgettrashtime and rsettrashtime in src/tools/main.cc incorrectly states to use the same command with -r flag. The correct commands are gettrashtime -r and settrashtime -r.
• Inconsistent use of eassert vs massert: The code uses both eassert and massert for similar checks. It would be better to use a single assertion macro for consistency.

Merge Readiness

The pull request is not quite ready for merging. The inconsistencies in the deprecation warning messages and the placement of the -l option warnings should be addressed. Additionally, the missing deprecation warning in sfstools.sh and the inaccurate deprecation message for rgettrashtime and rsettrashtime should be corrected. I am unable to approve this pull request, and recommend that these issues be addressed before merging. Please have others review and approve this code before merging.

[rolysr]

LGTM