Commit graph

617 commits

Author SHA1 Message Date
4e0d02b359 info/retreat info/lretreat: Fix and clean up
.SY claims all arguments are individually optional.  Fix that, and
clarify that omitting the optional arguments shows current orders.

Don't complicate syntax with <SECTS>, <SHIP/FLEET> covers sectors.

The two pages are identical apart from header and footer.  They
mention land units briefly, then explain ship retreat.  Lazy.  Drop
the land unit mention from "info retreat", and rewrite "info lretreat"
for land units.

Update example output for current code.

Don't shout retreat conditions.  We've always accepted both lower and
upper case conditions.  Help has been advertising lower case since
commit bb5dfd8, v4.3.16.

While there, fix a few misspellings and such.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2015-02-28 16:21:34 +01:00
75a049515b info/lretreat: Resync with retreat.t
Commit 18ee9a2f (v4.2.21) and commit 18ee9a2f (v4.3.16) updated only
info/retreat.t, and missed info/lretreat.t.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2015-02-28 16:21:34 +01:00
b4bdd658bd info/retreat: De-document retreat condition help
Documented in commit dc41544, v4.3.16.  It actually worked only at the
condition prompt then.  No longer recognized elsewhere since commit
c699949.  The documentation is now misleading.  Simply drop it; the
prompt points out how to get help,

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2015-02-28 16:21:34 +01:00
eb903207a4 info/mission: Correct land unit missile interdiction limit
It's not 100 flat, it's 20 per interdicted land unit.  It's been that
way since Empire 2 at least.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2015-02-28 16:13:15 +01:00
6bd7c64341 info/navigate: Correct and clarify
Don't claim the lowest-numbered land unit is always the leader.

Reword the explanation of the prompt.

Update example output for current code.

Clarify that a destination sector is also accepted interactively, not
just on the command line.

Missiles interdict just the valuable ships, unlike other interdiction.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2015-02-28 16:13:15 +01:00
8971d1b7bf info/march: Correct and clarify
Don't claim the army stops when the leader stops.

Don't claim the lowest-numbered land unit is always the leader.

The prompt shows minimum mobility, not leader mobility.

Clarify that a destination sector is also accepted interactively, not
just on the command line.  Fix the example output, and update for
current code.

Replace incorrect landmine hit chance formula by a reference to "info
Hitchance".

Drop incorrect damage limit for missile interdiction, rely on the
reference to "info mission" instead.

The hit chance of missiles and pin-bombers interdicting land units is
not 100%, but depends on the marching land unit that is easiest to hit.

Clarify that interdiction damage is spread evenly among the marching
land units.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2015-02-28 16:13:15 +01:00
a024dbb8a3 navigate: Require all ships to start in the same sector
The capability to navigate ships spread over several sectors is
obscure and rarely useful.  Accidental use is probably more frequent
than intentional use.  Issues:

* Interactive prompts show only the flagship's position, and give no
  clue that some ships are actually elsewhere.

* Path finding is supported only when all navigating ships are in
  the same sector.

* Interdiction becomes rather complex.  For each movement, every
  sector entered is interdicted independently.  This means the same
  fort, ship, land unit or plane can interdict multiple times.
  Interdiction order depends on the order the code examines
  ships. which the player can control.  This is all pretty much
  undocumented.

* Complicates the code and its maintenance.  Multiplies the number of
  test cases needed to cover navigate.

I feel we're better off without this feature.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2015-02-28 16:13:14 +01:00
69c99a0f29 march: Require all land units to start in the same sector
The capability to march land units spread over several sectors is
obscure and rarely useful.  Accidental use is probably more frequent
than intentional use.  Issues:

* Interactive prompts show only the leader's position, and give no
  clue that some land units are actually elsewhere.

* Path finding is supported only when all marching land units are in
  the same sector.

* In each step, the bmap is updated for the leader's radar.  The bmap
  is not updated around other marching land units.  Already odd when
  all units are in the leader's sector, and odder still when some are
  elsewhere.

* Interdiction becomes rather complex.  For each movement, every
  sector entered is interdicted independently.  This means the same
  ship, land unit or plane can interdict multiple times.  Interdiction
  order depends on the order the code examines land units. which the
  player can control.  This is all pretty much undocumented.

* Complicates the code and its maintenance.  Multiplies the number of
  test cases needed to cover march.

I feel we're better off without this feature.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2015-02-28 16:13:14 +01:00
dc73207a99 sail: Remove option SAIL
SAIL has issues:

* Sail orders are executed at the update.  Crafty players can use them
  to get around the update window.

* The route is fixed at command time.  You can't let the update find
  the best route, like it does for distribution.

* The info pages documenting it amount to almost 100 non-blank lines
  formatted.  They claim you can follow friendly ships.  This is
  wrong.  They also show incorrect follow syntax.  Unlikely to be the
  only errors.

* Few players use it.  Makes it a nice hidey-hole for bugs.  Here are
  two nice ones:

  - If follow's second argument is negative, the code attempts to
    follow an uninitialized ship.  Could well be a remote hole.

  - If ship #1 follows #2 follows #3 follows #2, the update goes into
    an infinite loop.

* It's more than 500 lines of rather crufty code nobody wants to
  touch.  Thanks to a big effort in Empire 2, it shares some code with
  the navigation command.  It still duplicates other navigation code.
  The sharing complicates fixing the bugs demonstrated by
  navi-march-test.

Reviewing, fixing and testing this mess isn't worth the opportunity
cost.  Remove it instead.  Drop commands follow, mquota, sail and
unsail.  Drop ship selectors mquota, path, follow.

struct shpstr shrinks some more, on my system from 160 to 120 bytes.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2015-02-28 16:11:28 +01:00
48e656c057 autonav: Remove the feature
The autonavigation feature has issues:

* Autonavigation orders are executed at the update.  Crafty players
  can use them to get around the update window.

* Usability is poor:

  - The order command is overly complex, not least because it can do
    five different things: clear, suspend, resume, declare route, set
    cargo levels.

  - Unlike every other command involving movement, order does not let
    you specify routes, only destination sectors.

  - Setting cargo levels can silently swap start and end point of a
    circular route, because "this keeps the load_it() procedure
    happy".  Maybe it does, but it surely keeps players confused.

  - Setting "start" cargo levels actually sets the "end" levels, and
    vice versa.  Has always been broken that way.

  - Predicting what exactly autonavigation will do at the update isn't
    easy.

* The info pages documenting it amount to almost 400 non-blank lines
  formatted.  They claim only merchant ships can be given orders.
  This is wrong.  Unlikely to be the only error.

* Few players use it, and its workings at the update a fairly opaque.
  Makes it a nice hidey-hole for bugs.  Here are two:

  - Unlike the scuttle command, autonavigation happily scuttles trade
    ships while they're on the trading block.

  - Unlike the load command, autonavigation can load in friendly and
    allied sectors.

* It's more than 700 lines of rather crufty code nobody wants to
  touch.  Thanks to a big effort in Empire 2, it shares code with the
  navigation command.  It still duplicates load code.  The sharing
  complicates fixing the bugs demonstrated by navi-march-test.

Reviewing, fixing and testing this mess isn't worth the opportunity
cost.  Remove it instead.  Drop commands order, qorder and sorder.
Drop ship selectors xstart, xend, ystart, yend, cargostart, cargoend,
amtstart, amtend, autonav.

xdump ship sheds almost half its columns.  struct shpstr shrinks, on
my system from 200 to 160 bytes.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2015-02-28 16:10:22 +01:00
a109de948b Remove option TREATIES
TREATIES has issues:

* Treaties can cover attack, assault, paradrop, board, lboard, fire,
  build (s|p|l|n) and enlist, but not bomb, launch, torpedo and
  enlistment centers.

* Usability is very poor.  While a treaty is in effect, every player
  action that violates a treaty condition triggers a prompt like this:

    This action is in contravention of  treaty #0 (with Curmudgeon)
    Do you wish to go ahead anyway? [yn]

  If you decline, the action is not executed.  If you accept, it is.
  In both cases, your decision is reported in the news.

  You cannot get rid of these prompts until the treaty expires.

* Virtually nobody uses them.

* Virtually unused code is buggy code.  There is at least one race
  condition: multifire() reads the firing sector, ship or land unit
  before the treaty prompt, and writes it back after, triggering a
  generation oops.  Any updates made by other threads while trechk()
  waits for input are wiped out, triggering a seqno mismatch oops.

* The treaty prompts could confuse smart clients that aren't prepared
  for them.  WinACE isn't, but is reported to work anyway at least
  common usage.  Ron Koenderink (the WinACE maintainer) suspects there
  could be a few situations where it will fail.

This feature is not earning its keep.  Remove it.  Drop command
treaty, consider treaty, offer treaty, xdump treaty, reject treaties.
Output of accept changed, obviously.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2014-02-16 11:44:14 +01:00
90eaf9d9eb tests/info: New; checks info and code agree on commands
Replaces info/checklist.pl, which has been broken since
commit 56d9445, v4.3.0.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2014-01-06 20:50:06 +01:00
0a702949db info/toc: New; generated machine-readable table of contents
Next commit will put it to use.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2014-01-06 20:50:06 +01:00
4709c68dad info/show: Update example to current output
White space change only, actually.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2014-01-06 20:50:03 +01:00
bb467c335d Update copyright notice
Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2014-01-02 14:33:48 +01:00
216470a8d5 edit: Implement edit nuke
Has been "not implemented yet" since the dawn of time.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2014-01-02 14:33:48 +01:00
5dd2cbd423 stockpile: New command, counterpart of fleetadd, wingadd, army
Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2014-01-02 14:33:48 +01:00
e010fa5f2f info/ndump: Belatedly update for v4.3.3's nuke storage change
Commit 2e40a4b (v4.3.3) changed ndump, but not its info page.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2014-01-02 14:33:47 +01:00
ee1f146dd8 Update change log again for 4.3.32
Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2013-08-25 09:56:58 +02:00
3cc23a3cd4 Update change log for 4.3.32
Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2013-08-17 17:57:37 +02:00
fbaaed0322 info/edit info/give: Add see also swapsector
Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2013-06-08 13:36:57 +02:00
4c68d14cc0 break: Honor new designation of sanctuaries
Breaking sanctuary turns 100% sanctuaries into capitals, all others
into highways.  Before Empire 3, sanctuaries always became capitals.

Give deities more control over initial state of countries than
choosing between 100% capital and <100% highway sectors: turn
sanctuaries into their new designation on break.  Except make a
capital when the new designation is sanctuary (which it normally is).

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2013-06-08 13:36:32 +02:00
5900e9b279 setsector setresource: Mark as obsolete
"info setsector" claims you "can change anything that appears in dump
or peek (I think)", which has always been wrong.

edit is much more complete.  However, edit used to be more limited in
that it could change only one sector.  For mass-changes, you had to
use setsector and setresource.  Since that limitation is gone, there's
no real use left for setsector and setresource.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2013-06-06 19:59:30 +02:00
f3cb215e1f edit: Generalize edit to multiple objects
Accept general <SECTS|SHIPS|PLANES|LANDS|NATS> argument instead of
just <SECT|SHIP|PLANE|LAND|NAT>.

edit with <KEY> <VALUE>... arguments applies the arguments to all
selected objects.  Without such arguments, edit lets you edit the
selected objects interactively one after the other.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2013-06-06 19:59:18 +02:00
7ebde795e7 info/version: Update example to current output
Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2013-05-26 17:13:52 +02:00
bb8169ba3a Put URIs and e-mail addresses in <angle brackets>
Also end URIs with '/' where appropriate.

Refrain from touching scripts/ and Stephen Crane's LWP authorship
note.

Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
2013-05-26 09:48:16 +02:00
94362ac8db Update change log again for 4.3.31 2013-05-12 18:59:42 +02:00
59a199c69d Don't put broken links in HTML info pages
Pass the valid info page names to emp2html.pl, and convert only valid
references to links there.
2013-05-12 18:53:02 +02:00
7a730be185 Tighten up emp2html's info reference recognition
Combine the two loops looking for \*QNAME\*U and "info NAME" into one.
Recognize "info NAME" only with the closing '"' to be present.

No change with current info sources.
2013-05-12 18:52:58 +02:00
955bdeb223 Fold subj2html.pl into emp2html.pl 2013-05-11 16:04:11 +02:00
320c8072fc Update change log for 4.3.31 2013-05-08 20:46:00 +02:00
2a1e039834 Fix "info Products" on how to query sector type p.e.
It's show sect capabilities, not stats.
2013-05-08 06:57:58 +02:00
3c84a8756e Improve how mksubj.pl reports malformed .SA argument 2013-05-08 06:57:57 +02:00
5d8f33f6ad .SA should come last, make mksubj.pl enforce it 2013-05-08 06:57:57 +02:00
21762a2c53 Subject pages confuse topics and subjects, fix
Confused since they were added in Empire 2.
2013-05-08 06:57:57 +02:00
bc8e3d3ffc Slightly less crude "info page is long" decision
"Unusually long" topics are marked with a "!" in subject indexes.
This should use the line count of the formatted page, but that's too
much trouble, so commit 4c0b4c0 (v4.3.27) approximated it by "source
file has more than 9999 bytes".  Change that to "source file has more
than 300 lines".
2013-05-08 06:57:57 +02:00
cd4cd8d0f7 Simplify how mksubj.pl keeps track of the subjects' topics
Extend global variable %Subjects to hold topics.  Drop global
variables %subject and %largest.
2013-05-08 06:57:57 +02:00
c8bd8202ce Simplify how mksubj.pl parses argument of .SA
Call parse_see_also() immediately.  Permits eliminating global
variables %see_also and %sanr.
2013-05-08 06:57:57 +02:00
156930c515 Make mksubj.pl touch subject files only when it needs to change
Avoids unnecessary reformatting of subject pages again.
2013-05-08 06:57:57 +02:00
890e88d149 Declare subjects instead of picking them up automatically
Since subjects were added in Empire 2, we've always picked them up
from .SA requests.  If you mistype a subject there, you get a "is a
NEW subject" warning, and incorrect subject pages.  When building a
pristine tree, you get bogus "is a NEW subject" warnings for all
subjects.  If you somehow delete the generated subjects.mk, but not
the generated subject files, the build breaks.

Declare subjects in Make variable subjects.  Drop generated makefile
subject.mk.

Treat unknown topics in .SA arguments as errors.  This replaces the
"$subj is a NEW subject" warning.

Treat subjects without member pages as errors.  This replaces the "The
subject $subj has been removed" warning.

Safer and simpler.
2013-05-08 06:57:57 +02:00
cbed134d81 Fix remaking of info subject pages
We used to do all the info indexing work in info.pl: find subjects,
create subjects.mk (to tell make the list of subjects), the subject
pages, and TOP.t.  Worked, but touching an info page triggered a full
rebuild of all subject pages and TOP.t.

Commit 2f14064 (v4.3.0) tried to avoid that by splitting info.pl into
findsubj.pl, mksubj.pl, mktop.pl.  findsubj.pl puts not just the
subjects into subjects.mk, but also make rules for the subject pages,
to guide their remaking.  mksubj.pl creates a single subject page.
mktop.pl creates TOP.t.

Unfortunately, this doesn't work so well.  Since subjects.mk doesn't
exist in a virgin tree, we use -include.  Unwanted consequence:
findsubj.pl failure doesn't stop make.  Moreover, the complex make
machinery breaks down when info sources get removed or subjects get
dropped.

Go back to the old method, except keep mktop.pl separate, as that part
works just fine, and use simpler make rules.  mksubj.pl now creates
subjects.mk and all subject pages, like info.pl did.

This effectively reverts most of commit 2f14064.  I'll address the
excessive rebuilding of subject pages in a different way shortly.
2013-05-08 06:57:57 +02:00
a2338a1db4 Pass subjects instead of subject filenames to info/mktop.pl
mktop.pl doesn't actually use the files, so this is simpler and
clearer.
2013-05-08 06:57:57 +02:00
9760dc9d12 Update info lost example to current output
Looks like this hasn't been done since Peter Langston's days...
2013-05-08 06:57:57 +02:00
e8742793e6 Drop trailing space in output of financial 2013-05-08 06:57:57 +02:00
14b31911dc Clean up some trailing whitespace 2013-05-08 06:57:57 +02:00
e9a69b6bc9 Replace .SA Obsolete by .LV Obsolete
Mark obsolete pages with '+' in subject pages.  Drop the separate
"Obsolete" subject page: move "info Innards" to subject "Server", and
"info update" to "Updates" (where it came from in commit a5764534,
v4.3.10).
2013-05-08 06:57:56 +02:00
b372ddeab4 Suppress explanation of '*' flag in subject pages when not used 2013-05-08 06:57:56 +02:00
f66a28079b Replace 'our' by 'my' in Perl scripts 2013-05-08 06:57:56 +02:00
5bf310e6b0 Convert "info Damage" from random(N) to 1dN notation 2013-05-08 06:55:20 +02:00
146454a6db Fix "info Damage" for shells, depth charges and torpedoes
Each random() is off by one there.
2013-05-08 06:55:20 +02:00