libcheck / check

A unit testing framework for C
GNU Lesser General Public License v2.1
1.07k stars 209 forks source link

Created Library Man Pages #310

Closed jflopezfernandez closed 3 years ago

jflopezfernandez commented 3 years ago

I've started creating man page documentation for the project, beginning with the suite_create(3) function. I've also created a project overview page describing what the project's goals are, and placed it in section 7, in accordance with accepted practice. For the project description, I used the description from the README.md file.

I also created the requisite Automake files and made the necessary configure.ac modifications to for the Autotools buildsystem to automatically install the man pages to the correct directories when the user runs make install.

Previews

The following previews were generated using groffer(1).

### suite_create.3 ![suite_create.3](https://imgur.com/EQUKxRd.png) ### libcheck.7 ![libcheck.7](https://imgur.com/Lhac0Cm.png)
brarcher commented 3 years ago

About the failure "osx / build_osx_autotools_other_args (pull_request)", the tests are not hermetic and involve installing some packages to the VMs/containers before starting the tests. Sometimes this fails. The specific issue this time was using brew.sh to download the mactex package for macOS. One way to get past it is attempting to retry the build. (Probably there could be a better way, to retry the download, but the test scripts are pretty simple). I don't know how the permissions work on GitHub actions. Do you have access to restart the tests with this button on the fail test(s)?

Screen Shot 2020-10-25 at 9 27 59 PM
jflopezfernandez commented 3 years ago

No, it doesn't look like I have that option. Should I add adding some error-handling to the TODO list?

brarcher commented 3 years ago

Should I add adding some error-handling to the TODO list?

Go for it

jflopezfernandez commented 3 years ago

@brarcher Hey, Brandon. I've pushed the updated commit removing the time stamp from the man pages, as well as the requisite ancillary Autoconf macro file and code in both the CMake and Autotools buildchain.

I had actually also forgotten to push a change where we could define all of the man pages in each section once, and then a foreach CMake loop configures and installs them without having to redefine them again later, so that's been pushed as well.

brarcher commented 3 years ago

Looks good!