microsoft / microsoft/terminal
Document ConDrv headers (condrv.h and conmsgl*.h)
Open
Area-Server
Issue-Docs
Issue-Task
Priority-3
Product-Conhost
- Dominant language
- C++
- Stars
- 105k
- Forks
- 9.6k
- Avg merge
- 3d 17h
- Merged PRs (30d)
- 29
Description
As the ConDrv headers and `\Device\ConDrv\Server` are undocumented, it:
* Prevents the community from building their own, alternative conhost
* is a hindrance for MS employees to quickly understand how ConDrv works
In the name of https://github.com/microsoft/terminal/issues/10462#issuecomment-864446348 I'd like to thus ask for ConDrv to be documented.
Contributor guide
Research direction
Start by reviewing condrv.h and the conmsgl*.h headers, along with the referenced discussion in issue #10462. Done means documenting the ConDrv headers and the \\Device\\ConDrv\\Server interface well enough for others to understand how ConDrv works.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation, operating-systems
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100