Re: [FFmpeg-devel] [RFC] Built-in documentation API

2020-08-24 Thread Jim DeLaHunt
On 2020-08-23 08:21, Nicolas George wrote: Since the idea of documentation built in the libraries seems popular, I have tried to outline an API to access it.… See the attached file […`documentation.c` omitted…]. Some comments about the API outline itself, from `documentation.c`: struct AVD

Re: [FFmpeg-devel] [RFC] Built-in documentation API

2020-08-23 Thread Chris Miceli
I'm new to the community and eager to help out with this work as well. Is there a reason why we would build something to do this rather than something like doxygen? It would mean that the team can point any contributors to the documentation for doxygen and the developers of ffmpeg will not need to

Re: [FFmpeg-devel] [RFC] Built-in documentation API

2020-08-23 Thread Jim DeLaHunt
On 2020-08-23 08:21, Nicolas George wrote: Since the idea of documentation built in the libraries seems popular, I have tried to outline an API to access it.… See the attached file […`documentation.c` omitted…]. The idea would be to have the build system convert the documentation into a C file

Re: [FFmpeg-devel] [RFC] Built-in documentation API

2020-08-23 Thread Alexander Strasser
First about this discussion in general: There is a reason this is tagged RFC and the other thread is called proposal. I hope we can go on with the vivid discussions while keeping in mind that it is not yet narrowed down and nothing is decided. Always constraining all ideas, is not a good way to o

Re: [FFmpeg-devel] [RFC] Built-in documentation API

2020-08-23 Thread Nicolas George
Hendrik Leppkes (12020-08-23): > I would at least want it to be optional. Of course. Also, it would be a new build-dep, it must be optional for that reason too. Although it would make harder to eliminate the descriptions in the source files like Alexander wants. Regards, -- Nicolas George

Re: [FFmpeg-devel] [RFC] Built-in documentation API

2020-08-23 Thread Hendrik Leppkes
On Sun, Aug 23, 2020 at 6:48 PM Marton Balint wrote: > > > > On Sun, 23 Aug 2020, Nicolas George wrote: > > > Since the idea of documentation built in the libraries seems popular, > > I don't like the idea of compiling the full help text into the binaries. > Libraries are already huge binaries, ad

Re: [FFmpeg-devel] [RFC] Built-in documentation API

2020-08-23 Thread Nicolas George
Marton Balint (12020-08-23): > It is loaded (or at least mmapped) into memory unconditionally. It is mmaped, and therefore only uses memory if it is used. Actually, when it is used, it ends up requiring less memory than other solutions. So I ask again: why do you consider it an issue? >

Re: [FFmpeg-devel] [RFC] Built-in documentation API

2020-08-23 Thread Marton Balint
On Sun, 23 Aug 2020, Nicolas George wrote: Marton Balint (12020-08-23): I don't like the idea of compiling the full help text into the binaries. Libraries are already huge binaries, adding the help text increases the binary size even more. Why do you consider this an issue? It does not take

Re: [FFmpeg-devel] [RFC] Built-in documentation API

2020-08-23 Thread Nicolas George
Marton Balint (12020-08-23): > I don't like the idea of compiling the full help text into the binaries. > Libraries are already huge binaries, adding the help text increases the > binary size even more. Why do you consider this an issue? It does not take more disk space in the binaries than in sep

Re: [FFmpeg-devel] [RFC] Built-in documentation API

2020-08-23 Thread Marton Balint
On Sun, 23 Aug 2020, Nicolas George wrote: Since the idea of documentation built in the libraries seems popular, I don't like the idea of compiling the full help text into the binaries. Libraries are already huge binaries, adding the help text increases the binary size even more. If we rea