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.

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

README: update manual install instructions #102

Merged
merged 1 commit into from
Jul 17, 2020

Conversation

chriscool
Copy link
Collaborator

The manual install instructions haven't worked since since #90. Let's update them.

This is an alternative to #100.

@rafasc
Copy link
Contributor

rafasc commented Jul 16, 2020

The markdown links are broken.


Adding sharness as a submodule, having a header on each test.t as follows:

: "${SHARNESS_TEST_DIRECTORY:=.}"
: "${SHARNESS_TEST_SRCDIR:=../sharness}"
. "${SHARNESS_TEST_SRCDIR}/sharness.sh"

and aggregate-results.sh and Makefile can be either copied or symbolic linked, mostly works;

However, it doesn't play well extensions, because they're loaded from $SHARNESS_TEST_SRCDIR: https://github.com/chriscool/sharness/blob/b57a2a49d6b5663388c8a146d7af5fdf63491fc9/sharness.sh#L488

Wouldn't it make more sense to allow those extensions to be tracked alongside the parent project? For that we would need to either load it from $SHARNESS_TEST_DIRECTORY or add another env to specify a custom directory. This would allow users to keep the submodule clean without custom changes.

Or am I missing the usecase for sharness.d ?

@chriscool
Copy link
Collaborator Author

@rafasc yeah, you are right that allowing extensions to be tracked alongside the parent project could be a good idea for some projects. Other projects might want to reuse extensions developed elsewhere though.

So I think I should merge this PR as is. But then I am open to improvements to this doc about this, so I have opened #103

About markdown links, I am going to take a look.

Thank you for your comment!

@chriscool chriscool merged commit dbb172f into master Jul 17, 2020
@chriscool
Copy link
Collaborator Author

I fixed the links in: 0a040a8
Sorry about forgetting it.

@felipec felipec deleted the update-manual-install-doc branch March 10, 2023 05:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants