bugLordsAWar! - Bugs: bug #32832, yelp can't find lordsawar manual

 
 

bug #32832: yelp can't find lordsawar manual

Submitted by:  Dmitrij D. Czarkoff <czarkoff>
Submitted on:  Fri 18 Mar 2011 02:09:02 PM UTC  
 
Category: NoneSeverity: 3 - Normal
Item Group: Git HeadStatus: None
Privacy: PublicAssigned to: None
Open/Closed: Closed

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

(Jump to the original submission Jump to the original submission)

Sat 19 Mar 2011 02:51:14 PM UTC, comment #15:

Whoops! I am sorry about that!

I forgot to give the same treatment to the files in help/figures.

revision 2590 fixes it.

Thanks for taking the time to follow up.

Ben Asselstine <benasselstine>
Project Administrator
Sat 19 Mar 2011 12:20:43 PM UTC, comment #14:

As of revision 2589 issue remains.

Dmitrij D. Czarkoff <czarkoff>
Sat 19 Mar 2011 02:32:15 AM UTC, comment #13:

The Makefiles in question are not useless. They are responsible for adding the files to the distribution tarball. It is simplest for me to have the Makefiles live where the files live that I want to include into the distribution tarball.

I won't be adding a --enable-gnome-docs configuration option, but if I did, it would be yet another reason for Makefiles in help/ -- because the action to install the files and run scrollkeeper would be implemented within an AM_CONDITIONAL.

The LordsAWar! source tree doesn't have a home/ directory, I think you probably meant to say help/.

It's helpful to have the Makefiles already there for future use, even though they don't do much right now. I guess it's just a workflow thing. Besides, the cost of keeping "a couple of Makefiles that do nothing" is truly negligible.

Ben Asselstine <benasselstine>
Project Administrator
Sat 19 Mar 2011 01:03:06 AM UTC, comment #12:

I believe my aproach to be better. You keep a couple of Makefiles that do nothing.

May be it would be a better idea to remove them until someone will be willing to write makefiles that would actually do something helpful? Regarding the dependencies of LordsAWar!,installation of GNOME helpfiles will likely need some more modification to building infrastructure ("./configure --enable-gnome-docs" or even "./configure --enable-local-docs [--enable-gnome]"depending on future development path).

Anyway, when the makefiles inside "home/" will get useful, hardly they will resamble what You make them look like right now. And as using docbook files needs manually copying them anyway, no need in makefiles is here.

Dmitrij D. Czarkoff <czarkoff>
Fri 18 Mar 2011 11:10:19 PM UTC, comment #11:

Thanks for looking into this.

svn revision 2588 builds fine for me, but it has been under some heavy modification.

The approach of removing the Makefiles works and it passes make distcheck. But I find this approach works better:

--- Makefile.am (revision 2578)
+++ Makefile.am (working copy)
@@ -1,9 +1,8 @@
SUBDIRS=figures
-EXTRA_DIST = $(help_DATA)
+EXTRA_DIST = $(noinst_DATA)
-helpdir = ${datadir}/gnome/help/lordsawar/C/
+#helpdir = ${datadir}/gnome/help/lordsawar/C/

-help_DATA = legal.xml \
- lordsawar.xml
+noinst_DATA = legal.xml lordsawar.xml

## for html publishing install docbook-utils:
## cd into this directory


This way I can potentially make a new makefile rule to create the html manual.

fixed in svn.

Thanks for reporting this bug.

Ben Asselstine <benasselstine>
Project Administrator
Fri 18 Mar 2011 09:38:07 PM UTC, comment #10:

I'm not sure, but my be the attached patch solves the issue.

(file #22964)

Dmitrij D. Czarkoff <czarkoff>
Fri 18 Mar 2011 09:13:45 PM UTC, comment #9:

SVN fails to build for me. Can't check anything.

Dmitrij D. Czarkoff <czarkoff>
Fri 18 Mar 2011 07:25:05 PM UTC, comment #8:

Please ensure that `make distcheck' finishes successfully.

Ben Asselstine <benasselstine>
Project Administrator
Fri 18 Mar 2011 07:22:55 PM UTC, comment #7:

I believe I've found the solution. If my test will be successful, I'll post it.

Dmitrij D. Czarkoff <czarkoff>
Fri 18 Mar 2011 07:10:10 PM UTC, comment #6:

Those files shouldn't be installed.

I probably couldn't find a way to get them into the tarball, but to somehow disable their installation to the system.

Can you help me find a way to fix this problem?

Ben Asselstine <benasselstine>
Project Administrator
Fri 18 Mar 2011 06:20:53 PM UTC, comment #5:

As I'm packaging lordsawar, I just remove $PREFIX/usr/share/gnome from packages. ;-)

But why should they continue to get installed by default without notice?

Dmitrij D. Czarkoff <czarkoff>
Fri 18 Mar 2011 05:05:20 PM UTC, comment #4:

Whoops!

Do you know how to prevent the installation of those files?

Ben Asselstine <benasselstine>
Project Administrator
Fri 18 Mar 2011 04:43:41 PM UTC, comment #3:

At least when lordsawar is built the followig way:

./configure --prefix=/usr --disable-static --disable-sdltest
make
make install

lordsawar installs following files:

/usr/share/gnome/help/
/usr/share/gnome/help/lordsawar/
/usr/share/gnome/help/lordsawar/C/
/usr/share/gnome/help/lordsawar/C/figures/
/usr/share/gnome/help/lordsawar/C/figures/army_bonus.png
/usr/share/gnome/help/lordsawar/C/figures/army_unit_info.png
/usr/share/gnome/help/lordsawar/C/figures/buy_production.png
/usr/share/gnome/help/lordsawar/C/figures/city_window.png
/usr/share/gnome/help/lordsawar/C/figures/conquer_city.png
/usr/share/gnome/help/lordsawar/C/figures/fight_city_one_vs_two.png
/usr/share/gnome/help/lordsawar/C/figures/fight_one_vs_one.png
/usr/share/gnome/help/lordsawar/C/figures/fight_order.png
/usr/share/gnome/help/lordsawar/C/figures/fighting_city_one_vs_two.png
/usr/share/gnome/help/lordsawar/C/figures/fighting_one_vs_one.png
/usr/share/gnome/help/lordsawar/C/figures/fought_city_one_vs_two.png
/usr/share/gnome/help/lordsawar/C/figures/fought_one_vs_one.png
/usr/share/gnome/help/lordsawar/C/figures/game_lobby.png
/usr/share/gnome/help/lordsawar/C/figures/game_options.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_buttons.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_center_on_stack_button.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_defend_stack_button.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_deselect_stack_button.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_diplomacy_button.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_diplomacy_proposed_button.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_end_turn_button.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_move_all_stacks_button.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_move_stack_button.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_move_stack_dir_buttons.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_park_stack_button.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_select_next_stack_button.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_stack_search_button.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_stat_icon_cities.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_stat_icon_income.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_stat_icon_treasury.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_stat_icon_upkeep.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_stat_icons.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_black_asterisk.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_black_caret.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_black_equals.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_black_gt.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_black_hash.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_black_lt.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_black_minus.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_black_pipe.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_black_plus.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_black_tilde.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_white_asterisk.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_white_caret.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_white_equals.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_white_gt.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_white_hash.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_white_lt.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_white_minus.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_white_pipe.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_white_plus.png
/usr/share/gnome/help/lordsawar/C/figures/main_screen_symbol_white_tilde.png
/usr/share/gnome/help/lordsawar/C/figures/mousecursor_boat.png
/usr/share/gnome/help/lordsawar/C/figures/mousecursor_goto.png
/usr/share/gnome/help/lordsawar/C/figures/mousecursor_hand.png
/usr/share/gnome/help/lordsawar/C/figures/mousecursor_magnifying_glass.png
/usr/share/gnome/help/lordsawar/C/figures/mousecursor_rook.png
/usr/share/gnome/help/lordsawar/C/figures/mousecursor_target.png
/usr/share/gnome/help/lordsawar/C/figures/mousecursor_walk.png
/usr/share/gnome/help/lordsawar/C/legal.xml
/usr/share/gnome/help/lordsawar/C/lordsawar.xml

These files actually are docbook user's manual, which is the subject of this report.

Dmitrij D. Czarkoff <czarkoff>
Fri 18 Mar 2011 02:28:40 PM UTC, comment #2:

Lordsawar purposely does not install the docbook user's manual. The manual is only available online. Fedora will be packaging the generated html manual so that Fedora users can read the manual while offline.

Feel free to take whatever steps you wish to install the user's manual on your system so that yelp can find it. The scrollkeeper set of utilities are responsible for managing these files so that yelp can find help documents.

Ben Asselstine <benasselstine>
Project Administrator
Fri 18 Mar 2011 02:15:19 PM UTC, comment #1:

It's also the case for 0.2.0 and all 0.2.0-pre?. Didn't try with earlier releases.

Dmitrij D. Czarkoff <czarkoff>
Fri 18 Mar 2011 02:09:02 PM UTC, original submission:

The package installs manual to $PREFIX/gnome/help/lordsawar.

Opening it with "yelp file://$PREFIX/gnome/help/lordsawar/C/lordsawar.xml" works, but "yelp ghelp:lordsawar" doesn't. Searching for "lordsawar" in Yelp either doesn't help.

Dmitrij D. Czarkoff <czarkoff>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

Attached Files
file #22964:  nohelp.patch added by czarkoff (1KiB - application/octet-stream - Leave docbook files untouched in dist tarball)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by benasselstine (Posted a comment)
  • -unavailable- added by czarkoff (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only logged-in users can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 4 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Fri 18 Mar 2011 11:10:19 PM UTCbenasselstineOpen/ClosedOpen=>Closed
    Fri 18 Mar 2011 09:38:07 PM UTCczarkoffAttached File-=>Added nohelp.patch, #22964
    Fri 18 Mar 2011 05:05:20 PM UTCbenasselstineOpen/ClosedClosed=>Open
    Fri 18 Mar 2011 02:28:40 PM UTCbenasselstineOpen/ClosedOpen=>Closed

    Back to the top


    Powered by Savane 3.1-cleanup1