[MacPorts] #62793: freeciv 2.6.4: port info doesn't explain the list of executable programs

[MacPorts]

#62793: freeciv 2.6.4: port info doesn't explain the list of executable programs
--------------------------+--------------------
  Reporter:  JDLH         |      Owner:  (none)
      Type:  enhancement  |     Status:  new
  Priority:  Low          |  Milestone:
 Component:  ports        |    Version:  2.6.4
Resolution:               |   Keywords:
      Port:  freeciv      |
--------------------------+--------------------

Comment (by ryandesign):

 Replying to [comment:2 JDLH]:
 > Are there other ports which install many components, or a very different
 subset than the upstream project installs? How do those ports communicate
 to the user about what MacPorts does?

 In some cases, ports need to diverge from upstream's default installation
 layout, for any number of reasons. Sometime's upstream's default
 installation layout is not appropriate in MacPorts. Sometimes upstream
 provides no installation method at all and we have to invent one. I don't
 have data about what proportion of ports do this.

 In most cases, ports do not communicate to the user. The user finds ports
 by name or by searching, installs a port, reads any notes the port prints,
 and uses `port contents` to figure out what was installed.

 > Would it be reasonable to at least add a sentence to the
 long_description saying something like, "Run 'man freeciv-client' for more
 information."?

 I would not add such information to the description because it seems
 redundant. Yes, users can consult manpages, but users should already be
 accustomed to using `port contents` to discover what manpages, info pages,
 or other documentation were installed.


 Replying to [comment:3 jmroot]:
 > Quick-start instructions can go in a port's `notes`.

 Yes they can, but it should be remembered that notes are printed not only
 after first installation but also after every port upgrade. Information
 that is only useful for initial setup quickly becomes spam. If we put too
 much spam in notes, it trains users to ignore notes.

-- 
Ticket URL: <https://trac.macports.org/ticket/62793#comment:4>
MacPorts <https://www.macports.org/>
Ports system for macOS