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

Missing information in Documentation #126

Closed
johnsamuelwrites opened this issue Nov 2, 2018 · 4 comments
Closed

Missing information in Documentation #126

johnsamuelwrites opened this issue Nov 2, 2018 · 4 comments
Assignees

Comments

@johnsamuelwrites
Copy link

Unit and functional tests

The documentation does not describe how to run the tests. There is a folder called test with the perl file run_all.pl. But the main wiki page does not talk about these tests. Also, if perl environment is required, this must also be added in Dependencies section and also in sections related to the different platforms.

Add links

Under the Download section, it is mentioned

To download all the project files, you can simply clone the repository using git (see git-basics).

Add a link to git-basics.

One suggestion for the Linux section, use apt instead of apt-get (section Linux)

For details on the review process, refer: openjournals/joss-reviews#1014

@vmagnin vmagnin self-assigned this Nov 16, 2018
@vmagnin
Copy link
Owner

vmagnin commented Nov 16, 2018

Dear John Samuel,

I have added a section in the wiki about testing gtk-fortran:
https://github.com/jerryd/gtk-fortran/wiki#testing-gkt-fortran
Let me know if you find these explications still confused. Perhaps the test.sh script should be moved to the test directory...

Note that there is some perl script because some developers in the project use them, but the users do not need them.

I have added a link in the wiki text toward the "git-basics" page.

I have replaced "apt-get' by "apt" in the wiki.

@johnsamuelwrites
Copy link
Author

Concerning running the test results, I ran the following command

./run_all.pl ../build/examples

But I get the following message.

bash: ./run_all.pl: Permission denied

Do I need any special permissions to run test cases)? Also please add the following lines under the testing section
$ cd test
$ ./run_all.pl ../build/examples

@vmagnin
Copy link
Owner

vmagnin commented Nov 19, 2018

bash: ./run_all.pl: Permission denied

Solved: I have made a chmod +x run_all.pl and push it to the master and gtk3 branch.

Also please add the following lines under the testing section
$ cd test
$ ./run_all.pl ../build/examples

Done.

Thank you for your vigilance.

@johnsamuelwrites
Copy link
Author

This is working. Now closing the ticket.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants