Macaulay2 / Macaulay2/M2

Duplicate documentation files

Open
#1,144 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

build issue Documentation
Dominant language
Macaulay2
Stars
435
Forks
297
Avg merge
4d 20h
Merged PRs (30d)
11

Description

There are 1 MB worth of duplicate documentation files after Macaulay2 is installed:

```
profzoom@gloria:/usr/share/doc/Macaulay2$ jdupes -rm .
Scanning: 13448 files, 580 items (in 1 specified)
90 duplicate files (in 84 sets), occupying 1 MB
```
(See https://gist.github.com/d-torrance/5e016cfe5e40096efceb1f6034d08535 for a more verbose report.)

This can be fixed by running `jdupes -rl` on the documentation directory after all the examples are generated. But of course this would require adding [jdupes](https://github.com/jbruchon/jdupes) to the list of dependencies for building Macaulay2. Is there interest in doing this?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the build step that generates examples and populates /usr/share/doc/Macaulay2; the issue names no source files or tests. Reproduce the report with jdupes -rm on that directory, then verify that the installed documentation no longer contains duplicate file sets after cleanup.

Written by the indexing model from the issue text.

Assessment

Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.