One more addition from me:
I have run into few gems, that had a VERSION file out of the lib directory, so it looked it's just a doc with the version, but it was actually read by files from lib and used in runtime (so if not present, the gem didn't work). So careful with files like this, you mustn't mark them as %doc nor put them in the doc subpackage.

---

Hi Ken,

On specs, tests, etc, we apply documentation packaging guidelines [1] and this is quote from reviewers guide:

MUST: If a package includes something as %doc, it must not affect the runtime of the application. To summarize: If it is in %doc, the program must run properly if it is not present.

I interpret is in this way: specs, tests, etc are not essential for package runtime, therefore I place them in -doc subpackage. Typical user is not installing -doc subpackage, so he does not waste his disk space. Also, test suite may help in better understanding how the library works, therefore it might be view as as documentation. So if there is test suite, keep it, if there is non, do nod add it. Its question to upstream if you have different opinion.

The inclusion of test suite in gem is more generic question for Ruby community. For example Rails does not include its test suite and I find it correct. On the other hand, there is some infrastructure in RubyGems which should allow to execute the test suite of gem during installation, but I never tried it personally, I don't believe it will work reasonably.


Vit




[1] http://fedoraproject.org/wiki/Packaging/Guidelines#PackageDocumentation





Dne 26.4.2012 00:49, Ken Dreyer napsal(a):

I'm wondering about how to handle things like the Rakefile, or /spec,
or /test directories in rubygem packages. My inclination is to leave
these out of the package to keep it slimmer, but I see that some
rubygems do include them in the package (or at least the -doc
subpackage). The example on the Ruby packaging guidelines also
includes these in -doc.

Are these files really that useful to ship to end users?

- Ken
_______________________________________________
ruby-sig mailing list
ruby-sig@lists.fedoraproject.org
https://admin.fedoraproject.org/mailman/listinfo/ruby-sig

_______________________________________________
ruby-sig mailing list
ruby-sig@lists.fedoraproject.org
https://admin.fedoraproject.org/mailman/listinfo/ruby-sig

--