net-offloads icon indicating copy to clipboard operation
net-offloads copied to clipboard

Add Prototype Pseudocode

Open nibanks opened this issue 1 year ago • 6 comments

nibanks avatar Jun 08 '23 14:06 nibanks

Can this go in its own file? The qeo_ndis header is meant to contain NDIS definitions for QEO.

mtfriesen avatar Jun 08 '23 14:06 mtfriesen

Can this go in its own file? The qeo_ndis header is meant to contain NDIS definitions for QEO.

It could, but it's going to get deleted eventually anyways, so why does it matter?

nibanks avatar Jun 08 '23 15:06 nibanks

This seems like it belongs in markdown; the point of this header file is to take the code snippets in the QEO markdown file and produce something an actual compiler will accept. Why would we prefer putting non-compiling, commented-out pseudo code into the compiler-readable header file rather than a human-readable markdown file, which also provides the opportunity for rich text description between code blocks?

mtfriesen avatar Jun 08 '23 15:06 mtfriesen

This seems like it belongs in markdown; the point of this header file is to take the code snippets in the QEO markdown file and produce something an actual compiler will accept. Why would we prefer putting non-compiling, commented-out pseudo code into the compiler-readable header file rather than a human-readable markdown file, which also provides the opportunity for rich text description between code blocks?

Done.

nibanks avatar Jun 08 '23 15:06 nibanks

I don't want to be super nit-picky, but why is the markdown file in the include directory?

I guess I'm just a bit lost: what is the intent of this pseudo code? Is this meant to be a non-normative extension of the QEO spec, sample code, or something driver developers actually include in their projects?

mtfriesen avatar Jun 08 '23 15:06 mtfriesen

I want it close to the actual source since it's generally meant to help describe how you will use it. Right now I want to focus on the content, not the location/format.

nibanks avatar Jun 08 '23 15:06 nibanks