View Issue Details

IDProjectCategoryView StatusLast Update
0006098DarkRadiantDocumentationpublic13.01.2024 05:32
Reporteres20490446e Assigned Toorbweaver  
PrioritylowSeverityminorReproducibilityalways
Status closedResolutionfixed 
Fixed in Version3.4.0 
Summary0006098: Include doc in building instructions
DescriptionAt "README.md", the building instructions don't include the docs:

PackageDocs () {
    local TargetDir="${pkgdir}/usr/share/doc/${pkgname}"

    mkdir --parents "${TargetDir}"
    cp --recursive "${srcdir}/${pkgname}/doc"/* "${TargetDir}"
    rm "${TargetDir}/CMakeLists.txt"
}
TagsNo tags attached.

Activities

orbweaver

orbweaver

28.09.2022 19:26

developer   ~0015280

I'm confused as to what your "shell script" represents, and how it relates the README. If you're on Linux, the CMake build already handles creating and installing the docs if you have the required AsciiDoctor command in your path, so there is no need to manually move things around with shell commands. It's true that the README doesn't currently mention how to create the docs manually, but wouldn't this primarily be a concern for Windows users (who aren't using CMake or shell scripts)?
es20490446e

es20490446e

29.09.2022 14:06

reporter   ~0015281

Let me have a look...
es20490446e

es20490446e

29.09.2022 22:39

reporter   ~0015282

Last edited: 29.09.2022 22:40

By installing asciidoctor I get the docs compiled.

I guess it shall be mentioned at:
- https://github.com/codereader/DarkRadiant/blob/master/README.md
- https://wiki.thedarkmod.com/index.php?title=DarkRadiant_-_Compiling_in_Linux

That said, in that last page, the dependencies for Arch Linux and Manjaro shall be the same.

And the real line is:
sudo pacman -Syu asciidoctor base-devel boost git gtest eigen freealut ftgl glew libjpeg-turbo libsigc++ libpng libvorbis libxml2 wxwidgets-gtk3 zlib
orbweaver

orbweaver

04.10.2022 19:18

developer   ~0015290

Use of "asciidoctor" command now mentioned in the README for building on Linux, as of Git commit 24952830ccdf75d10d260dc120d1bd2887a5c94a
es20490446e

es20490446e

04.10.2022 22:21

reporter   ~0015292

Where is it mentioned?

Related Changesets

DarkRadiant: master 24952830

04.10.2022 19:16

orbweaver


Details Diff
0006098: mention 'asciidoctor' dependency when building on Linux Affected Issues
0006098
mod - README.md Diff File

Issue History

Date Modified Username Field Change
17.09.2022 02:47 es20490446e New Issue
17.09.2022 06:11 greebo Status new => acknowledged
28.09.2022 19:26 orbweaver Note Added: 0015280
29.09.2022 14:07 es20490446e Note Added: 0015281
29.09.2022 22:39 es20490446e Note Added: 0015282
29.09.2022 22:40 es20490446e Note Edited: 0015282
29.09.2022 22:40 es20490446e Note Edited: 0015282
29.09.2022 22:40 es20490446e Note Edited: 0015282
04.10.2022 19:18 orbweaver Assigned To => orbweaver
04.10.2022 19:18 orbweaver Status acknowledged => resolved
04.10.2022 19:18 orbweaver Resolution open => fixed
04.10.2022 19:18 orbweaver Fixed in Version => 3.4.0
04.10.2022 19:18 orbweaver Note Added: 0015290
04.10.2022 22:21 es20490446e Note Added: 0015292
06.10.2022 16:56 orbweaver Changeset attached => DarkRadiant master 24952830
13.01.2024 05:32 greebo Status resolved => closed