search

frenetic-lang / netcore-1.0

Compiler from NetCore to OpenFlow and associated tools.
BSD 3-Clause "New" or "Revised" License
14 stars 3 forks source link

Documentation: haddock #13

Closed astory closed 12 years ago

astory commented 12 years ago
  1. Intentions
  2. What we've tested on
  3. Haddock
astory commented 12 years ago

Haddock is underway pretty well; we need someone to update the README to include points 1 and 2.

cschlesi commented 12 years ago

We should add more thorough comments to at least a few key examples (like the MAC learning example).

princedpw commented 12 years ago

I concur -- it was pretty challenging to figure out the layout of the dataflow diagram. I am sure we could do it but it would take some time to put the pieces together. Also, ASCII art flow diagrams are always fun:

---pkt_ch--[query_gen]--foo_ch--[pol_gen]--bof_ch--[Controller] | ---- baz_ch ------------------------|

:-)

Dave

On Wed, Aug 8, 2012 at 3:39 PM, cschlesi notifications@github.com wrote:

We should add more thorough comments to at least a few key examples (like the MAC learning example).

— Reply to this email directly or view it on GitHubhttps://github.com/frenetic-lang/netcore/issues/13#issuecomment-7594893.

astory commented 12 years ago

Some of these were written rather recently, and only just now settled down, but yeah, we should write more documentation for them.

On Wed, Aug 8, 2012 at 3:54 PM, David Walker notifications@github.comwrote:

I concur -- it was pretty challenging to figure out the layout of the dataflow diagram. I am sure we could do it but it would take some time to put the pieces together. Also, ASCII art flow diagrams are always fun:

---pkt_ch--[query_gen]--foo_ch--[pol_gen]--bof_ch--[Controller] | ---- baz_ch ------------------------|

:-)

Dave

On Wed, Aug 8, 2012 at 3:39 PM, cschlesi notifications@github.com wrote:

We should add more thorough comments to at least a few key examples (like the MAC learning example).

— Reply to this email directly or view it on GitHub< https://github.com/frenetic-lang/netcore/issues/13#issuecomment-7594893>.

— Reply to this email directly or view it on GitHubhttps://github.com/frenetic-lang/netcore/issues/13#issuecomment-7595332.

Alec Story Cornell University Biological Sciences, Computer Science 2012

princedpw commented 12 years ago

Overall, though, it is super-exciting. Great work!

Dave

On Wed, Aug 8, 2012 at 3:58 PM, Alec Story notifications@github.com wrote:

Some of these were written rather recently, and only just now settled down, but yeah, we should write more documentation for them.

On Wed, Aug 8, 2012 at 3:54 PM, David Walker notifications@github.comwrote:

I concur -- it was pretty challenging to figure out the layout of the dataflow diagram. I am sure we could do it but it would take some time to put the pieces together. Also, ASCII art flow diagrams are always fun:

---pkt_ch--[query_gen]--foo_ch--[pol_gen]--bof_ch--[Controller] | ---- baz_ch ------------------------|

:-)

Dave

On Wed, Aug 8, 2012 at 3:39 PM, cschlesi notifications@github.com wrote:

We should add more thorough comments to at least a few key examples (like the MAC learning example).

— Reply to this email directly or view it on GitHub< https://github.com/frenetic-lang/netcore/issues/13#issuecomment-7594893>.

— Reply to this email directly or view it on GitHub< https://github.com/frenetic-lang/netcore/issues/13#issuecomment-7595332>.

Alec Story Cornell University Biological Sciences, Computer Science 2012

— Reply to this email directly or view it on GitHubhttps://github.com/frenetic-lang/netcore/issues/13#issuecomment-7595435.

astory commented 12 years ago

Some minor updates: bb8ad5ab4b1c9e2dd7275c4f7c37985863c146c3

arjunguha commented 12 years ago

Haddock docs aren't perfect, but we'll release with this.