> Subject: Re: [EXT] Re: [PATCH] doc: fix cryptodev code block mismatch > > 21/03/2023 15:57, Akhil Goyal: > > > 21/03/2023 14:05, Akhil Goyal: > > > > Certain structures were replicated in programmer's guide, > > > > which resulted in mismatch when that structure is changed > > > > in future releases. > > > > Added literal includes to copy code block while compiling. > > > > > > The best is to avoid including code in docs. > > > Why do we need these structures in the guide? > > > > > These are not complete code, only the structure defines > > Which helps in understanding the fields and flow of APIs. > > I'm not opposed, but in general I think it is better > to explain the global design and usage flow in the guides. > The detailed API is explained in the doxygen comments.
Agreed with your point, and I do feel some of these can be removed. But there is mismatch in the structs along past releases. I thought of fixing this in stable releases, and we can remove whichever Not required in future release. > > With that said, you are the maintainer, so we rely on your choices :) > Thank you for your trust. Moreover, I am always open for suggestions and improvements.
