[petsc-dev] Add links to implementations from manual pages

Smith, Barry F. bsmith at mcs.anl.gov
Mon Dec 18 15:08:16 CST 2017


   Patrick,

     Automatically adding links to the manual pages to implementations is actually pretty straight forward. In lib/petsc/conf/rules look at, for example,
manconcepts. You can just make a copy of that and have it use something like 

git grep -n "^PetscErrorCode MatMult_"

to generate the files and line numbers for all implementations and plop them into the manual page. It maybe require some tuning to get the ones you want but not the other ones. But remember don't let the perfect prevent the useful.

Questions?

    Good luck,

    Barry

This is how we build the manual pages. Unix style, many small utilities that add stuff to the manual pages. Not one big honking script that tries to do everything for the manual pages.






More information about the petsc-dev mailing list