Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Register
  • Sign in
  • xorgproto xorgproto
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 19
    • Issues 19
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 8
    • Merge requests 8
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • xorgxorg
  • proto
  • xorgprotoxorgproto
  • Issues
  • #25
Closed
Open
Issue created Mar 11, 2020 by Adam Jackson@ajax🎧Owner

Clean up the protocol documentation

There's kind of two overlapping issues here. One is that the specifications are not in consistent formats, some are text and some are xml. Two, made worse by the first point, is that the specs are in principle normative, but there's no easy way to extract data types or enums from them.

I tend to lean toward markdown as the most pleasant output format, partly because it should then be easy to integrate into the gitlab wiki, but I'd take any reasonable structured format. It would probably be a good idea at this point to generate the final protocol documentation from a template and the XCB definitions (after we've re-double-checked that they concur), so that future additions are harder to leave undocumented.

To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information
Assignee
Assign to
Time tracking