From: Alex R. <sh...@al...> - 2003-11-26 19:11:01
|
Hi, It seems a nice idea to have FAQ text available as a help menu item. It's implemented now except for one important thing: FAQ file has to be =20 installed somewhere (so far it is a part of EXTRA_DIST). It seems resonable to install FAQ where the docs are. To that end, all =20 our docs up to date were Gnome help in XML format, and that went to =20 $PREFIX/$PACKAGE/gnome/help/$PACKAGE (something like /usr/local/share/gramps/gnome/help/gramps depending on your =20 install options). I have the following questions targeted at our installation experts: 1. What would be the good place for the FAQ file installation? 2. Wouldn't we also want to keep FAQ in top level distribution =20 directory? 3. Could somebody please take care of Makefile.am changes to implement =20 the desired policy? I have to confess -- I get dizzy very quickly after =20 reading through Makefiles, especially when auto-tools are involved :-) Alexander, Tim, Don -- what do you say? Thanks, Alex --=20 Alexander Roitman http://ebner.neuroscience.umn.edu/people/alex.html Dept. of Neuroscience, Lions Research Building 2001 6th Street SE, Minneapolis, MN 55455 Tel (612) 625-7566 FAX (612) 626-9201 |
From: Alex R. <sh...@al...> - 2003-11-26 22:53:52
|
On 2003.11.26 16:37, dpe...@si... wrote: > On Wed, 26 Nov 2003, Alex Roitman had this to say: >> >> It seems a nice idea to have FAQ text available as a help menu item. =20 >> It's implemented now except for one important thing: FAQ file has to = =20 >> be installed somewhere (so far it is a part of EXTRA_DIST). It =20 >> seems resonable to install FAQ where the docs are. To that end, all = =20 >> our docs up to date were Gnome help in XML format, and that went to >=20 > Why not have the FAQ implemented as part of the documentation, like =20 > an Appendix? I do not think it is proper to have a plain text =20 > document in the GNOME help tree.=20 I agree -- that's why I asked about the proper place to put it :-) Making FAQ an appendix is a workable idea. Does it sit OK with =20 everybody? The only advantage of plain text displayed in its own window =20 I can see is that the users have something to hold on to if Yelp is =20 broken. However, we probably should not worry about it being broken and =20 just forget about a separate window. > It would be better to put them (plain-text files) > somewhere like /usr/local/doc/gramps/ (or, more precisely, > $PREFIX/doc/$PACKAGE/) as is done with many projects. It seems > kind of silly to have a directory with one entry, though, perhaps we =20 > could also place the ChangeLog file there as well. This is actually what's going on with Debian packages:=20 /usr/share/doc/$PACKAGE is mandatory and usually contains ChangeLogs =20 (both upstream and debian), NEWS, TODOs, etc, so that would be a proper =20 place for the plain text FAQ file. We don't have to worry about this =20 since it's done by debian maintainer at packaging time. I'm not sure =20 how RPMs handle this, probably through gramps.spec files. > >2. Wouldn't we also want to keep FAQ in top level distribution =20 > >directory? >=20 > Maybe. I'm not sure about this. I think we should. This is similar in all regards to NEWS, TODO, =20 ChangeLog, etc. If people build from source, all they get is a tarball =20 and then FAQ's place is right there, at the top level. The reason I =20 asked is that I added it to EXTRA_DIST to have it packed in the =20 tarball. I'm not sure whether this is OK if it's going to be installed =20 elswehere (i.e. adding it to some installation target may remove the =20 need from being added to EXTRA_DIST). Alex --=20 Alexander Roitman http://ebner.neuroscience.umn.edu/people/alex.html Dept. of Neuroscience, Lions Research Building 2001 6th Street SE, Minneapolis, MN 55455 Tel (612) 625-7566 FAX (612) 626-9201 |
From: <dpe...@si...> - 2003-12-01 18:04:58
|
On Wed, 26 Nov 2003, Alex Roitman had this to say: >On 2003.11.26 16:37, dpe...@si... wrote: >> On Wed, 26 Nov 2003, Alex Roitman had this to say: >>> >>> It seems a nice idea to have FAQ text available as a help menu item. >> >> It would be better to put them (plain-text files) >> somewhere like /usr/local/doc/gramps/ (or, more precisely, >> $PREFIX/doc/$PACKAGE/) as is done with many projects. It seems >> kind of silly to have a directory with one entry, though, perhaps we >> could also place the ChangeLog file there as well. > >This is actually what's going on with Debian packages: >/usr/share/doc/$PACKAGE is mandatory and usually contains ChangeLogs >(both upstream and debian), NEWS, TODOs, etc, so that would be a proper >place for the plain text FAQ file. We don't have to worry about this >since it's done by debian maintainer at packaging time. I'm not sure >how RPMs handle this, probably through gramps.spec files. Yes. The RPMs just need an appropriate entry in the %files section. Of course, this implies that the 'make install' step places those files there as well. >> >2. Wouldn't we also want to keep FAQ in top level distribution >> >directory? >> >> Maybe. I'm not sure about this. > >I think we should. This is similar in all regards to NEWS, TODO, >ChangeLog, etc. If people build from source, all they get is a tarball >and then FAQ's place is right there, at the top level. The reason I Agreed. I guess I should have said I was indifferent, rather than unsure. You've convinced me, though. :) >asked is that I added it to EXTRA_DIST to have it packed in the >tarball. I'm not sure whether this is OK if it's going to be installed I think this should be fine, but maybe someone else more intimate (hint, hint, Alexandre) with autotools can comment better. Cheers, -Don -- ________________________________________________ Donald A. Peterson | dpe...@si... Ph.D. Research Associate | Dept. of Chemistry | PH: (541) 737-7079 Oregon St. University | FAX: (541) 737-0480 ------------------------------------------------ |
From: Alex R. <sh...@al...> - 2003-12-02 05:29:52
|
On Wed, Nov 26, 2003 at 02:37:20PM -0800, dpe...@si... wrote: > On Wed, 26 Nov 2003, Alex Roitman had this to say: > > > >It seems resonable to install FAQ where the docs are... >=20 > ... It would be better to put them (plain-text files) > somewhere like /usr/local/doc/gramps/ (or, more precisely, > $PREFIX/doc/$PACKAGE/) as is done with many projects. It seems > kind of silly to have a directory with one entry, though, perhaps we coul= d=20 > also place the ChangeLog file there as well. I think it's a good idea to install the following files under something=20 like $(datadir)/share/@PACKAGE@ : AUTHORS COPYING COPYING-DOCS ChangeLog FAQ INSTALL NEWS README TODO I would like to ask somebody more experienced with autotools to get this=20 done. If nobody ventures, I will try doing it, but I'd much rather have=20 someone with more knowledge to do this (sorry for being redundant :-) The autotool gurus, please help! Alex --=20 Alexander Roitman http://ebner.neuroscience.umn.edu/people/alex.html Dept. of Neuroscience, Lions Research Building 2001 6th Street SE, Minneapolis, MN 55455 Tel (612) 625-7566 FAX (612) 626-9201 |
From: Tim W. <tw...@re...> - 2003-12-02 10:42:18
|
On Mon, Dec 01, 2003 at 11:29:51PM -0600, Alex Roitman wrote: > I think it's a good idea to install the following files under something= =20 > like $(datadir)/share/@PACKAGE@ : Probably $(datadir)/doc/@PACKAGE@, or $(docdir)/@PACKAGE@? Anyway: >=20 > AUTHORS > COPYING > COPYING-DOCS > ChangeLog > FAQ > INSTALL > NEWS > README > TODO >=20 > I would like to ask somebody more experienced with autotools to get this= =20 > done. If nobody ventures, I will try doing it, but I'd much rather have= =20 > someone with more knowledge to do this (sorry for being redundant :-) Isn't it sufficient to do this in the vendor-packaging layer? For RPMs, for instance, I just adjusted gramps.spec.in to do what we want. Tim. */ |
From: Alex R. <sh...@al...> - 2003-12-02 14:14:43
|
On Tue, Dec 02, 2003 at 10:42:13AM +0000, Tim Waugh wrote: > On Mon, Dec 01, 2003 at 11:29:51PM -0600, Alex Roitman wrote: > > I think it's a good idea to install the following files under something= =20 > > like $(datadir)/share/@PACKAGE@ : >=20 > Probably $(datadir)/doc/@PACKAGE@, or $(docdir)/@PACKAGE@? Anyway: Oops, I meant "doc" where I typed "share", you're right ;-) =20 > > AUTHORS > > COPYING > > COPYING-DOCS > > ChangeLog > > FAQ > > INSTALL > > NEWS > > README > > TODO > >=20 > > I would like to ask somebody more experienced with autotools to get thi= s=20 > > done. If nobody ventures, I will try doing it, but I'd much rather have= =20 > > someone with more knowledge to do this (sorry for being redundant :-) >=20 > Isn't it sufficient to do this in the vendor-packaging layer? For > RPMs, for instance, I just adjusted gramps.spec.in to do what we want. I guess so. The only problem this brings is that I'd like to know the=20 location of FAQ file so that I can display it from within the program (Help->FAQ). Should I just give up this idea? Alex --=20 Alexander Roitman http://ebner.neuroscience.umn.edu/people/alex.html Dept. of Neuroscience, Lions Research Building 2001 6th Street SE, Minneapolis, MN 55455 Tel (612) 625-7566 FAX (612) 626-9201 |