RFC: standardizing SVN properties in the doc repo

[Benedict Reuschling]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Am 19.10.12 14:31, schrieb Gabor Kovesdan:
> Hi,
> 
> currently, the proper use of SVN properties and dealing with file types
> are not standardized in the doc repo. I propose the following policy for
> the repo:
> 
> - Use the .sh extension for shell scripts so that they can be easily
> identified as such
> 
> - Always add the $FreeBSD$ keyword and set svn:keywords to FreeBSD=%H if
> you create a text non-binary file that support escaping it.
> 
> - Only set fbsd:nokeywords for non-binary (i.e. human-readable) files if
> there are no ways to escape the keyword.
> 
> - If SVN detects your non-binary file as binary (may happen with
> non-Latin encodings), DO NOT SET fbsd:nokeywords but use fbsd:notbinary.
> 
> - If SVN complains that a binary file does not have the keyword, first
> try to set the correct mime-type (see below) and only set
> fbsd:nokeywords if SVN still rejects the file.
> 
> .css	text/css
> .dtd	application/xml-dtd
> .ent	application/xml-dtd
> .gif	image/gif
> .gz	application/gzip
> .html	text/html
> .ico	image/vnd.microsoft.icon
> .jpg	image/jpeg
> .js	application/javascript
> .log	text/plain
> .pdf	application/pdf
> .png	image/png
> .rss	application/rss+xml
> .sh	text/plain
> .svg	image/svg+xml
> .txt	text/plain
> .xml	application/xml
> .xsl	application/xslt+xml
> 
> If there are no objections, I'll give a sweep to the tree to make it
> consistent and I'll document this.
> 
> Gabor

Sounds like a good thing to do to me. We should probably put this into
the primer as well, so that for future files (of any extension) people
can look up the correct keywords to set.

Regards

Benedict

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.8 (Darwin)
Comment: GPGTools - http://gpgtools.org
Comment: Using GnuPG with Mozilla - http://www.enigmail.net/

iEYEARECAAYFAlCBSTEACgkQTSZQLkqBk0jmVwCgsi8eJz8uTk1NhSRqVWIwIZe1
S84AnjDFeVdD9s9I5I6K8K6iNmUSWQKx
=e6ZN
-----END PGP SIGNATURE-----