Problem: links-search-files is set up incorrectly #40
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Solution: Set to the file name, not the name of the directory name. New problem: This makes document generation work fully, which breaks for e.g. r6rs-doc.
The own links file was not pointed to. Solution: Adjust own links file in the template.
Packages that depend on racket-index want to write to $HOME when building their documentation. racket-index wants to update its documentation database in the user scope, if it can't find the database in installation scope. Solution: For now, patch racket-index to always write to installation scope.
When we corrected the problem with our own links-file, the workaround of creating directories in .../collects became unnecessary. Solution: Remove the workaround.
While troubleshooting other attributes, I discovered that the default doc-search-dirs ends up being $package/share/racket/collects/doc. Solution: Make doc-search-dirs explicit in config.rktd.
There are some circular dependencies in there. They can be made to
work.
The top package is the one that was detected as a circular dependency
by the bottom package and was cut out of the circle. The top package
transitively depends on the rest of the circle, the others are cut off
at the bottom package.
Here's how we can make this work:
1. Don't run setup on any bottom package.
There are some true circular dependencies in there, that won't work
unless the dependency has had a proper setup and registered its
collections. They can be made to work by doing some extra work in the
top (not necessarily, but we were lucky enough that it was the top --
the circle was only two packages) package:
2a. Remove the bottom package from the config.rktd dependencies.
2b. Install both the top and bottom packages in the top installation
scope.
2c. Run setup on both.
Solution: To get a starting point to work from, first make some ugly
special cases to solve these specific packages. Work on a generic
solution from here.
htdp-lib and deinprogramm-signature have a true circular dependency
that can be solved by (2) (verified with htdp-lib as top).
racket-doc and drracket have a circular dependency that works by just
doing (1) -- force both to not do any setup for now. The racket-doc
package has a whole drove of circular dependencies with other -doc
packages.
For discussion of next steps, see issue fractalide#38.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Solution: Set up links-search-files correctly
This releases a whole can of worms, because several dormant mechanisms suddenly come into play.
These commits are a step toward solving #3, and they also partially solve #34, while giving rise to #38 and #39.