document the MANIFEST.in-replacing capabilities of setuptools_scm

[ThomasWaldmann]

Dealing with MANIFEST.in and the package data include/exclude stuff in setup.py usually is a pain.
Either stuff is missing or you include crap accidentally.

setuptools_scm seems to handle this elegantly, but the README and docs focus on its version handling capabilities and don't tell much about the manifest/package-data related functionality.

After noticing that (more or less accidentally, iirc by some other docs mentioning that setuptools_scm can do that based on what's added to git) I did that PR: borgbackup/borg@feb428b

There was also a little discussion about it there: borgbackup/borg#3355

I didn't notice a problem with that yet.

The only thing to remember is to exclude unwanted files via MANIFEST.in.

[RonnyPfannschmidt]

@ThomasWaldmann would you consider the current readme header sufficient or should there be a more complete example?

[ThomasWaldmann]

Much better already!

Maybe it should mention both special cases that need attention:

• SCM-managed but unwanted files must be excluded in MANIFEST.in
• not-SCM-managed but wanted files must be included in MANIFEST.in

Guess the latter could be auto-generated stuff at / before sdist creation time.

[webknjaz]

• SCM-managed but unwanted files must be excluded in MANIFEST.in
• not-SCM-managed but wanted files must be included in MANIFEST.in

@RonnyPfannschmidt I wonder if we should instead recommend customizing git_describe_command? Thoughts?

[RonnyPfannschmidt]

@webknjaz i don't follow how the file finder is related to the describe command

[webknjaz]

Oh, I must've confused its use seeing that it talks about the ability to have --exclude

[RonnyPfannschmidt]

closing as solved, its mentioned in both the readme and the new mkdocs docs