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

[Patrick Sanan]

Thanks, Barry! I think in terms of quick usefulness this is a great one and
I'll try to get it done soon.



2017-12-18 13:08 GMT-08:00 Smith, Barry F. :

>
>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.
>
>
>
>
>

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

[Smith, Barry F.]

   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.