Skip to content

adrdox: init at v1.0.0 #62739

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

adrdox: init at v1.0.0 #62739

wants to merge 1 commit into from
+63 −0

Conversation

zopsicle
Copy link

@zopsicle zopsicle commented Jun 5, 2019

Adding a package for the adrdox documentation generator for D.

Motivation for this change

I like this tool and it wasn't in Nixpkgs so I added it to Nixpkgs. It is used by several D projects for generating HTML documentation from source code.

Things done
  • Tested using sandboxing (nix.useSandbox on NixOS, or option sandbox in nix.conf on non-NixOS)
  • Built on platform(s)
    • NixOS
    • macOS
    • other Linux distributions
  • Tested via one or more NixOS test(s) if existing and applicable for the change (look inside nixos/tests)
  • Tested compilation of all pkgs that depend on this change using nix-shell -p nix-review --run "nix-review wip"
  • Tested execution of all binary files (usually in ./result/bin/)
  • Determined the impact on package closure size (by running nix path-info -S before and after)
  • Assured whether relevant documentation is up to date
  • Fits CONTRIBUTING.md.

Sorry, something went wrong.

@ofborg ofborg bot added the 8.has: documentation This PR adds or changes documentation label Jun 5, 2019
alexarice
alexarice reviewed Jun 6, 2019
View reviewed changes
Copy link
Contributor

@alexarice alexarice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally an install command would be added to the makefile upstream so that you do not need a custom install phase

@zopsicle zopsicle mentioned this pull request Jun 7, 2019
Closed
@zopsicle
Copy link
Author

zopsicle commented Jun 7, 2019

adrdox got a proper version number now. I’ll update the PR and address the review comments this weekend.

@zopsicle zopsicle changed the title adrdox: init at 20190508 adrdox: init at v1.0.0 Jun 7, 2019
@ofborg ofborg bot added 8.has: package (new) This PR adds a new package 11.by: package-maintainer This PR was created by the maintainer of the package it changes 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 labels Jun 7, 2019
@zopsicle
Copy link
Author

zopsicle commented Jun 7, 2019

I've addressed each remark and squashed.

aanderse
aanderse requested changes Jun 9, 2019
View reviewed changes
maintainers/maintainer-list.nix
@@ -948,6 +948,11 @@
github = "chiiruno";
name = "Okina Matara";
};
chloekek = {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please rewrite your git history into 2 single commits. The first commit should be adding this entry to maintainer-list.nix and the second should be the other commits squashed into 1.

pkgs/development/tools/documentation/adrdox/cross-platform.patch
+ dmd doc2.d latex.d cgi.d comment.d stemmer.d dom.d script.d jsvar.d html.d color.d -J. $(LIBDPARSE) -g # -version=std_parser_verbose
#dmd -of/var/www/dpldocs.info/locate locate.d dom.d stemmer.d cgi -J. -version=fastcgi -m64 -debug
locate:
dmd -of/var/www/dpldocs.info/locate locate.d dom.d stemmer.d cgi -J. -version=fastcgi -m64 -debug postgres.d database.d -L-L/usr/local/pgsql/lib
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this patch written by you or did you find it upstream somewhere? Is there an issue upstream to fix this? A patch like this ideally doesn't belong in nixpkgs but should be in upstream.

pkgs/development/tools/documentation/adrdox/default.nix

stdenv.mkDerivation rec {
pname = "adrdox";
version = "v1.0.0";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The version part of the name attribute must start with a digit (following a dash) — e.g., "hello-0.3.1rc2".

pkgs/development/tools/documentation/adrdox/default.nix
src = fetchFromGitHub {
owner = "adamdruppe";
repo = "adrdox";
rev = version;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Given comment above this should be rev = "v${version}";.

pkgs/development/tools/documentation/adrdox/default.nix

src = fetchFromGitHub {
owner = "adamdruppe";
repo = "adrdox";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

repo = pname; is a fairly common thing to do.

adrdox: init at v1.0.0
2326384 
Adding a package for the adrdox documentation generator for D.
@stale
Copy link

stale bot commented Jun 2, 2020

Thank you for your contributions.
This has been automatically marked as stale because it has had no activity for 180 days.
If this is still important to you, we ask that you leave a comment below. Your comment can be as simple as "still important to me". This lets people see that at least one person still cares about this. Someone will have to do this at most twice a year if there is no other activity.
Here are suggestions that might help resolve this more quickly:

  1. Search for maintainers and people that previously touched the
    related code and @ mention them in a comment.
  2. Ask on the NixOS Discourse. 3. Ask on the #nixos channel on
    irc.freenode.net.

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 2, 2020
@ryantm ryantm added 2.status: merge conflict This PR has merge conflicts with the target branch and removed 2.status: merge conflict This PR has merge conflicts with the target branch labels Oct 3, 2020
@stale stale bot removed the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Oct 3, 2020
@ryantm ryantm added 2.status: merge conflict This PR has merge conflicts with the target branch and removed 2.status: merge conflict This PR has merge conflicts with the target branch labels Oct 3, 2020
@stale
Copy link

stale bot commented Jun 6, 2021

I marked this as stale due to inactivity. → More info

@stale stale bot added the 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md label Jun 6, 2021
@SuperSandro2000
Copy link
Member

Closing due to inactivity from author.

@Janik-Haag Janik-Haag added the 12. first-time contribution This PR is the author's first one; please be gentle! label Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alexarice alexarice

@aanderse aanderse

Assignees
No one assigned
Labels
2.status: merge conflict This PR has merge conflicts with the target branch 2.status: stale https://github.com/NixOS/nixpkgs/blob/master/.github/STALE-BOT.md 8.has: documentation This PR adds or changes documentation 8.has: package (new) This PR adds a new package 10.rebuild-darwin: 1-10 10.rebuild-linux: 1-10 11.by: package-maintainer This PR was created by the maintainer of the package it changes 12. first-time contribution This PR is the author's first one; please be gentle!
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@zopsicle @SuperSandro2000 @aanderse @alexarice @ryantm @Janik-Haag