Skip to content
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

add scdoc documentation tool #8598

Merged
merged 1 commit into from
Jan 12, 2022
Merged

add scdoc documentation tool #8598

merged 1 commit into from
Jan 12, 2022

Conversation

aacebedo
Copy link
Contributor

Specify library name and version: scdoc/1.11.12

I am not the author of the tool but I need it for some of my projects.

  • I've read the guidelines for contributing.
  • I've followed the PEP8 style guides for Python code in the recipes.
  • I've used the latest Conan client version.
  • I've tried at least one configuration locally with the
    conan-center hook activated.

@conan-center-bot

This comment has been minimized.

Sign in to view
@conan-center-bot

This comment has been minimized.

Sign in to view
@conan-center-bot

This comment has been minimized.

Sign in to view
@conan-center-bot

This comment has been minimized.

Sign in to view
@conan-center-bot

This comment has been minimized.

Sign in to view
@prince-chrismc prince-chrismc mentioned this pull request Dec 31, 2021
Open
uilianries
uilianries reviewed Jan 3, 2022
View reviewed changes
Copy link
Member

@uilianries uilianries left a comment

Choose a reason for hiding this comment

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

Thank you for your contribution, please, take a look on my review.

recipes/scdoc/all/conanfile.py Outdated Show resolved Hide resolved
recipes/scdoc/all/conanfile.py Outdated Show resolved Hide resolved
recipes/scdoc/all/conanfile.py Outdated
return "source_subfolder"

def build_requirements(self):
self.build_requires("make/[>=4.3.0]")
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
self.build_requires("make/[>=4.3.0]")
self.build_requires("make/4.3.0]")

Ranged version is not allowed for Conan Center

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is a comment here #8588 (comment) indicating ranges may be considered for build dependencies. Is it confirmed ?

recipes/scdoc/all/conanfile.py Outdated Show resolved Hide resolved
recipes/scdoc/all/conanfile.py Outdated Show resolved Hide resolved
recipes/scdoc/all/test_package/conanfile.py Outdated Show resolved Hide resolved
recipes/scdoc/all/test_package/conanfile.py Outdated Show resolved Hide resolved
recipes/scdoc/all/conanfile.py Outdated Show resolved Hide resolved
recipes/scdoc/all/conanfile.py Outdated Show resolved Hide resolved
recipes/scdoc/all/conanfile.py Outdated Show resolved Hide resolved
@conan-center-bot

This comment has been minimized.

Sign in to view
uilianries
uilianries previously approved these changes Jan 4, 2022
View reviewed changes
Copy link
Member

@uilianries uilianries left a comment

Choose a reason for hiding this comment

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

LGTM Thank you!

@aacebedo
Copy link
Contributor Author

aacebedo commented Jan 4, 2022

LGTM Thank you!

@aacebedo aacebedo closed this Jan 4, 2022
@aacebedo aacebedo reopened this Jan 4, 2022
@conan-center-bot

This comment has been minimized.

Sign in to view
@conan-center-bot

This comment has been minimized.

Sign in to view
uilianries
uilianries previously approved these changes Jan 4, 2022
View reviewed changes
Copy link
Member

@uilianries uilianries left a comment

Choose a reason for hiding this comment

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

LGTM

prince-chrismc
prince-chrismc previously approved these changes Jan 10, 2022
View reviewed changes
SSE4
SSE4 previously approved these changes Jan 10, 2022
View reviewed changes
@aacebedo aacebedo dismissed stale reviews from SSE4 and prince-chrismc via f75c752 January 10, 2022 07:10
@conan-center-bot
Copy link
Collaborator

All green in build 9 (f75c7529f16d457dc10fcdc252b6b7a0ca42f8dd):

  • scdoc/1.11.12@:
    All packages built successfully! (All logs)

@prince-chrismc
Copy link
Contributor

Why did you rebase and force push?

Your PR was ready to be merged 😱 I opened a PR since the docs were not clear #8797

@prince-chrismc
Copy link
Contributor

Please do not force push 🙏 GitHub forces us to restart the review which is not fun!

@aacebedo
Copy link
Contributor Author

I am terribly sorry :(

I force pushed because I identified an issue with the pkg-config file generated by the recipe (It did not include the same info as the one packaged with the source preventing it to be used by other packages to use it correctly).

Shall I use fixup commits instead to apply modifications during a review ?

@prince-chrismc
Copy link
Contributor

That's absolutely alright. Thanks for catching the issue!

Please make new commits 🙏 it's much easier for us to review that way.

uilianries
uilianries reviewed Jan 11, 2022
View reviewed changes
recipes/scdoc/all/conanfile.py
self.output.info(
"Appending PATH environment variable: {}".format(scdoc_root))
self.env_info.PATH.append(scdoc_root)
self._chmod_plus_x(os.path.join(scdoc_root, "scdoc"))
Copy link
Member

Choose a reason for hiding this comment

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

We usually do it when packaging, but I think you want to be sure the user will have permission to execute the binary.

uilianries
uilianries approved these changes Jan 11, 2022
View reviewed changes
Copy link
Member

@uilianries uilianries left a comment

Choose a reason for hiding this comment

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

LGTM

@conan-center-bot conan-center-bot merged commit d362fde into conan-io:master Jan 12, 2022
miklelappo pushed a commit to miklelappo/conan-center-index that referenced this pull request Feb 9, 2022
@aacebedo @miklelappo
(conan-io#8598) add scdoc documentation tool
b6c08b9
datalogics-robb pushed a commit to datalogics-robb/conan-center-index that referenced this pull request Mar 6, 2023
@datalogics-kam
Merge branch 'master' of github.com:conan-io/conan-center-index into …
69c1592 
…update-from-conan-io

* 'master' of github.com:conan-io/conan-center-index: (480 commits)
  (conan-io#8840) wslay: modernize
  (conan-io#8830) Deprecate diligentgraphics-spirv-tools
  (conan-io#8829) Deprecate diligentgraphics-spirv-headers
  (conan-io#8828) Deprecate diligentgraphics-vulkan-headers
  (conan-io#8819) nanoflann: add 1.4.2 + modernize
  (conan-io#8814) coin-lemon: restore .names["pkg_config"]
  (conan-io#8797) Let contributors know to avoid rebasing
  (conan-io#8809) libalsa: restore .names["pkg_config"] + add ALSA_CONFIG_DIR to runenv_info
  (conan-io#8807) pkgconf: restore .names["pkg_config"]
  (conan-io#8741) spirv-headers: fix pkg_config name + modernize
  (conan-io#8732) oniguruma: modernize
  (conan-io#8684) libtiff: modernize
  (conan-io#8632) cpython: Add PATH variable only if env_vars option is enabled.
  (conan-io#7331) (conan-io#7329) Support Gandiva in Arrow 2.0.0
  (conan-io#8598) add scdoc documentation tool
  (conan-io#8796) backport-cpp: modernize
  (conan-io#8793) cpp-ipc: add version 1.2.0
  (conan-io#8778) variant-lite: modernize
  (conan-io#8777) string-view-lite: modernize
  (conan-io#8775) scope-lite: modernize
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SSE4 SSE4 SSE4 approved these changes

@uilianries uilianries uilianries approved these changes

@prince-chrismc prince-chrismc prince-chrismc approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@aacebedo @conan-center-bot @prince-chrismc @SSE4 @uilianries