Build/install doc is terrible

Bug #857263 reported by Chris Hillery
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Zorba
Fix Released
High
Chris Hillery

Bug Description

The build.dox, installation.dox, build_ubuntu.dox, and several related files have numerous errors. Here are some:

- build.dox mentions there are a number of build options, but does not document them. (It previously pointed to a page of *XQuery* options, but I deleted that link.)

- installation.dox includes stuff about building (not just installing), and that stuff is all Makefile-specific.

- installation.dox refers to setting LD_LIBRARY_PATH and so on which is not, as far as I know, required. The final section about ldconfig on Ubuntu is also obsolete and wrong as far as I know.

- build_ubuntu.dox is not entirely accurate, but a lot of it is redundant with the main build instructions.

- If we have build_ubuntu.dox, we should probably have separate pages for (at least) Fedora, Windows, and MacOS too. There is a lot of information specific to Linux, Windows, and MacOS on the main build page that could probably be spread around.

Tags: doc

Related branches

Revision history for this message
Chris Hillery (ceejatec) wrote :

Also, the module interdependency graph, while interesting, is not very good for documentation purposes. We need a brief textual definition for all such dependencies. (Currently I explicitly call out the http-client module's dependency on data-converters/tidy, since that is almost certain to be the most commonly hit.)

Changed in zorba:
assignee: nobody → Chris Hillery (ceejatec)
Chris Hillery (ceejatec)
Changed in zorba:
importance: Undecided → High
Changed in zorba:
milestone: none → 2.1
Changed in zorba:
milestone: 2.1 → 2.2
Changed in zorba:
milestone: 2.2 → 2.5
Chris Hillery (ceejatec)
Changed in zorba:
status: New → In Progress
Changed in zorba:
status: In Progress → Fix Committed
Changed in zorba:
status: Fix Committed → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.