/qubes-issues

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

qrexec docs look like a big mess #1392

Open
rootkovska opened this Issue Nov 8, 2015 · 6 comments

Comments

Assignees

@marmarek marmarek

Labels
Projects
None yet
Milestone
  Ongoing
4 participants
@rootkovska @andrewdavidwong @marmarek @fosslinux
@rootkovska
Member

rootkovska commented Nov 8, 2015

https://www.qubes-os.org/doc/qrexec3-implementation/
https://www.qubes-os.org/doc/qrexec2-implementation/
https://www.qubes-os.org/doc/qrexec3/
https://www.qubes-os.org/doc/qrexec/

Please fix. Also deprecate qrexec2 docs (potentially don't list in the main Content, only link from the qrexec3 docs pages). We really only need two qrexec-documenting pages: one for developers of qrexec-based services, and one for qrexec internals.

Also, please, please, make the pages look less ugly.

@rootkovska rootkovska added bug C: doc labels Nov 8, 2015

@rootkovska rootkovska assigned andrewdavidwong Nov 8, 2015

@andrewdavidwong andrewdavidwong closed this in QubesOS/qubes-doc@3fe2f6e Nov 9, 2015

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Nov 9, 2015

Member

@rootkovska, let me know what you think. (IMHO, it's cleaner just to have a single page for each one.)
Member

andrewdavidwong commented Nov 9, 2015

@rootkovska, let me know what you think. (IMHO, it's cleaner just to have a single page for each one.)

andrewdavidwong added a commit to QubesOS/qubes-doc that referenced this issue Nov 9, 2015

@andrewdavidwong
Make direct links to internals sections (QubesOS/qubes-issues#1392)
Unverified
The email in this signature doesn’t match the committer email.
GPG key ID: 8CE137352A019A17 Learn about signing commits
bffa21f

marmarek added a commit to QubesOS/qubesos.github.io that referenced this issue Nov 9, 2015

@marmarek
autoupdate: _doc 
_doc:
    tag axon_bffa21f6
    tagger Axon <axon@openmailbox.org> 1447028433 +0000

    Tag for commit bffa21f6134301e27d8f746f9a8667ff44148088
    gpg: Signature made Mon 09 Nov 2015 01:20:33 AM CET using RSA key ID 2A019A17
    gpg: Good signature from "Axon (Qubes Documentation Signing Key)"

    bffa21f Make direct links to internals sections (QubesOS/qubes-issues#1392)
Verified
This commit was signed with a verified signature.
@marmarek marmarek Marek Marczykowski-Górecki
GPG key ID: F32894BE9684938A Learn about signing commits
64b6b32
@marmarek

This comment has been minimized.

Show comment
Hide comment
@marmarek

marmarek Nov 9, 2015

Member

I'm not sure about having a single page with both qrexec app writers and qrexec-internals, but it may work with some clear separation of those parts.

Anyway the qrexec3 internals documentation sucks. At very least we need a similar diagram as in qrexec2 internals (of course updated to qrexec3 protocol). But the protocol description itself could use some rework. This is something I have in my TODO list for some time...
Member

marmarek commented Nov 9, 2015

I'm not sure about having a single page with both qrexec app writers and qrexec-internals, but it may work with some clear separation of those parts.

Anyway the qrexec3 internals documentation sucks. At very least we need a similar diagram as in qrexec2 internals (of course updated to qrexec3 protocol). But the protocol description itself could use some rework. This is something I have in my TODO list for some time...

andrewdavidwong added a commit to QubesOS/qubes-doc that referenced this issue Nov 9, 2015

@andrewdavidwong
Make separation of internals section more pronounced 
QubesOS/qubes-issues#1392
Unverified
The email in this signature doesn’t match the committer email.
GPG key ID: 8CE137352A019A17 Learn about signing commits
b92bedd
@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Nov 9, 2015

Member

I've made the separation of the internals section even more pronounced (by adjusting the heading levels), but it can easily be split off into a separate page if you prefer.
Member

andrewdavidwong commented Nov 9, 2015

I've made the separation of the internals section even more pronounced (by adjusting the heading levels), but it can easily be split off into a separate page if you prefer.

@rootkovska rootkovska reopened this Nov 9, 2015

marmarek added a commit to QubesOS/qubes-linux-utils that referenced this issue Nov 11, 2015

@marmarek
qrexec: define NOGUI_CMD_PREFIX 
This is part of the qrexec protocol, so keep it in protocol definitions.

QubesOS/qubes-issues#1392
Verified
This commit was signed with a verified signature.
@marmarek marmarek Marek Marczykowski-Górecki
GPG key ID: 063938BA42CFA724 Learn about signing commits
dfe5c11

marmarek added a commit to QubesOS/qubes-core-agent-linux that referenced this issue Nov 11, 2015

@marmarek
Bump qubes-utils version requirement 
Those commits needs updated qubes-utils:
823954c qrexec: use #define for protocol-specified strings
5774c78 qfile-agent: move data handling code to libqubes-rpc-filecopy

QubesOS/qubes-issues#1324
QubesOS/qubes-issues#1392
Verified
This commit was signed with a verified signature.
@marmarek marmarek Marek Marczykowski-Górecki
GPG key ID: 063938BA42CFA724 Learn about signing commits
1643874
@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Nov 13, 2015

Member

@rootkovska, did you mean to leave this assigned to me when you reopened it? If so, what else would you like me to do?
Member

andrewdavidwong commented Nov 13, 2015

@rootkovska, did you mean to leave this assigned to me when you reopened it? If so, what else would you like me to do?

@marmarek marmarek assigned marmarek and unassigned andrewdavidwong Nov 13, 2015

marmarek added a commit to QubesOS/qubes-linux-utils that referenced this issue Nov 25, 2015

@marmarek
qrexec: add clarification commends in qrexec.h 
QubesOS/qubes-issues#1392
Verified
This commit was signed with a verified signature.
@marmarek marmarek Marek Marczykowski-Górecki
GPG key ID: 063938BA42CFA724 Learn about signing commits
cd27748

@woju woju closed this in woju/qubesos.github.io@f671293 Nov 26, 2015

@marmarek marmarek reopened this Nov 26, 2015

marmarek added a commit to QubesOS/qubes-linux-utils that referenced this issue Dec 11, 2015

@marmarek
qrexec: add clarification commends in qrexec.h 
QubesOS/qubes-issues#1392

(cherry picked from commit cd27748)
Verified
This commit was signed with a verified signature.
@marmarek marmarek Marek Marczykowski-Górecki
GPG key ID: 063938BA42CFA724 Learn about signing commits
ddcbe6f

@marmarek marmarek added the P: major label Jan 7, 2016

@marmarek marmarek added this to the Documentation/website milestone Jan 7, 2016

@marmarek

This comment has been minimized.

Show comment
Hide comment
@marmarek

marmarek May 15, 2016

Member

While at it: add info about #1876
Member

marmarek commented May 15, 2016

While at it: add info about #1876

marmarek added a commit to QubesOS/qubes-doc that referenced this issue May 15, 2016

@marmarek
qrexec: update qrexec-client-vm usage and using script as a service 
QubesOS/qubes-issues#1392
Verified
This commit was signed with a verified signature.
@marmarek marmarek Marek Marczykowski-Górecki
GPG key ID: F32894BE9684938A Learn about signing commits
c1aef22

marmarek added a commit to QubesOS/qubes-doc that referenced this issue May 15, 2016

@marmarek
qrexec: add policy argument info 
QubesOS/qubes-issues#1392
QubesOS/qubes-issues#1876
Verified
This commit was signed with a verified signature.
@marmarek marmarek Marek Marczykowski-Górecki
GPG key ID: F32894BE9684938A Learn about signing commits
3dbb70c
@fosslinux

This comment has been minimized.

Show comment
Hide comment
@fosslinux

fosslinux Jun 5, 2018

@marmarek You're assigned, what more needs to be done on this?

fosslinux commented Jun 5, 2018

@marmarek You're assigned, what more needs to be done on this?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment