Page MenuHomeFreeBSD

sysutils/snapraid: Backup program for disk arrays
ClosedPublic

Authored by diizzy on Aug 18 2021, 9:02 PM.

Details

Summary

New port, also needs entry in sysutils/Makefile

Test Plan

Poudriere testport OK 12.2-RELEASE (amd64), 11.4-RELEASE (amd64)

Diff Detail

Repository
R11 FreeBSD ports repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

diizzy created this revision.

Rule number one of "new ports": Wire them in :)

-> sysutils/Makefile

A few questions from my end,

COMMENT should probably say "Backup program for disk arrays" or something along those lines?
Ref: https://pkgs.alpinelinux.org/package/edge/testing/aarch64/snapraid , https://packages.debian.org/unstable/source/snapraid

INSTALL_MAN installs example as 444, ${CP} as 644 which is probably more suitable?

Do we have any style guidelines regarding double spacing vs single in pkg-descr?

I've also received permission from submitter (and maintainer) to do changes if needed

COMMENT should probably say "Backup program for disk arrays" or something along those lines?

agreed, shorter sounds better

INSTALL_MAN installs example as 444, ${CP} as 644 which is probably more suitable?

Don't use ${CP} to install files. See https://docs.freebsd.org/en/books/porters-handbook/book/#install -- INSTALL_DATA would also give you 644

Do we have any style guidelines regarding double spacing vs single in pkg-descr?

I'm not aware of any style-guides. The porters handbook also does not give you any guidelines about the styling https://docs.freebsd.org/en/books/porters-handbook/book/#porting-desc (apart from the WWW).
Personally I would likely remove the double spaces and reformat it to around ~80 columns.

I've also received permission from submitter (and maintainer) to do changes if needed

Being a committer gives you this right per default :D (https://docs.freebsd.org/en/books/porters-handbook/book/#makefile-maintainer) -- but having permission is always preferable :)

I have intentionally chosen this COMMENT to highlight that this is not an ordinary backup program, but rather performs some RAID-like functionality.

Quite honestly I find this whole discussion pretty pointless. I spent a good chunk of time making sure this port is correct and now I feel like I have to justify every single decision I made all over again. I mean, come on? What are we talking about? A COMMENT that could have been different? Double-spacing in pkg-descr? Reflowing pkg-descr to a different line length? None of this is wrong or prevents the port in any way from being perfectly fine and usable. And none of that is in violation of the Porter's Handbook either. Not sure why we need to make a DR and talk about this for so long. Sounds more like an attempt to find something, anything that needs to be changed.

Let's not spend ages talking about what colour to paint the bikeshed in, shall we?

After private discussion with @tcberner, how about

File-level Backup/RAID program for disk arrays.

It is important to highlight that this is not a run-of-the-mill backup program and neither is it a run-of-the-mill RAID program. It's sort of a cross between the two.

Add entry in sysutils/Makefile
INSTALL_MAN --> INSTALL_DATA for sample config file
Reformat pkg-desc

sysutils/snapraid/Makefile
7

^ why are you not just using the comment suggested by the maintainer File-level Backup/RAID program for disk arrays

@lbartoletti USE_GITHUB does not seem possible: this is an autotools project and the release tarballs have pre-generated autotools files that aren't in the repository. I've previously been told off for using USE_GITHUB and regenerating the configure script in such a case.

@lbartoletti USE_GITHUB does not seem possible: this is an autotools project and the release tarballs have pre-generated autotools files that aren't in the repository. I've previously been told off for using USE_GITHUB and regenerating the configure script in such a case.

That's correct, "Release" downloads are preferred.

Looks good to me.

sysutils/snapraid/Makefile
20

As I have already explained to other committers on IRC, this tool does not have a reasonable default configuration. The configuration file is merely an example for how to set up your own configuration and cannot be used as is. As explained in the Porter's handbook, @sample should not be used in such cases.

This revision is now accepted and ready to land.Aug 24 2021, 8:53 AM
sysutils/snapraid/Makefile
20

I see, then INSTALL_DATA makes sense indeed.

sysutils/snapraid/Makefile
4

That's only if you want to use GitHub generated (on the fly) archives

stlgtm

@diizzy do you know how to set the author properly for the commit? -- it should reflect the maintainer.

@tcberner
I think so, https://docs.freebsd.org/en/articles/committers-guide/ -->
"Example 3. Commit Log for a Commit Based on a PR"

git commit --author "John Smith <John.Smith@example.com>"

@tcberner
I think so, https://docs.freebsd.org/en/articles/committers-guide/ -->
"Example 3. Commit Log for a Commit Based on a PR"

git commit --author "John Smith <John.Smith@example.com>"

Exactly -- when pushing, you will be refused to do so :) -- but it will also tell you how to get it through.