dm-tool: `add-seat` poorly documented
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Quiet
- Tech stack
- bash, c
- Domain
- cli, documentation
Research direction
Start with the dm-tool(1) man page and its Bash completion entry, then inspect the cited src/display-manager-service.c:229 call to understand the deprecation. Document what TYPE means for add-seat, note the deprecation, and remove add-seat from Bash completion; verify the resulting man page and completion behavior.
Written by the indexing model from the issue text.
Description
Hi. This was reported on Debian BTS.
The code and the error message suggest that the AddSeat() method is deprecated. What's more is that dm-tool(1) doesn't explain what arguments are expected when running dm-tool add-seat.
So, there seems to be two closely related issues:
add-seat TYPEisn't explained at all. It's not obvious whatTYPErefers to here.- Its deprecation isn't documented in the man page.
Considering that https://github.com/canonical/lightdm/blob/de09f2c34175b44e12c4a49c87905812576f9661/src/display-manager-service.c#L229
is always called whenever AddSeat() is invoked, I think it'd be best to mention its deprecation in the man page and drop add-seat from Bash completion.
- Dominant language
- C
- Stars
- 1k
- Forks
- 168
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ubuntu/lightdm
-
regression
Difficulty 3/5 1-2 days Newbie friendliness 64/100
-
xdmcp/vnc/xdmc
Difficulty 3/5 1-2 days Newbie friendliness 58/100
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
help wanted
Difficulty 4/5 3-5 days Newbie friendliness 48/100
-
Difficulty 4/5 3-5 days Newbie friendliness 65/100
Similar issues
-
level/task module/gcp type/bug
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
-
docs
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
P3 sonic-vpp
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
sonic-net/sonic-buildimage#29662 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
spack/spack-packages#6586 ·
-
category:port-update
Difficulty 2/5 1-3 hours Newbie friendliness 72/100