code documentation

[john.david.r.smith]

hi.
is there any code + structure documentation?
e.g.:
1) a list of all files associated with a vm + what is stored in them
2) a documentation of data stored for each vm
3) source code documentation / documentation of code structure

if there is no such thing, i would propose to add something like this,
because it lowers the barrier of entrance for devs to help with the project.

-john

[Andrew David Wong]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

All of the developer documentation on qubes-os.org is here:

https://www.qubes-os.org/doc/#for-developers

In particular, take a look here:

https://www.qubes-os.org/doc/system-doc/

And here:

https://www.qubes-os.org/doc/source-code/

However, the qubes-core-admin docs are hosted separately here:

https://qubes-core-admin.readthedocs.io/en/latest/

You may be interested in this section in particular:

https://qubes-core-admin.readthedocs.io/en/latest/qubes-vm/index.html

- --
Andrew David Wong (Axon)
Community Manager, Qubes OS
https://www.qubes-os.org
-----BEGIN PGP SIGNATURE-----

iQIcBAEBCgAGBQJXRh21AAoJENtN07w5UDAwvrQQAJnkeMhlkLeN9BKGuUaWhcd7
t/J2TGX6NyA5al770z7T4ILLVV+pltpOzQkMb4oFWTUgIe7hslqiEV3vjchO+sv0
t7M95G5OI3BauEfYiNM5t7uAD+29PwfdI1hQI4KgxqDbutNCEBhPekAzSyxgE7DE
SgG7DOINu3kcBIEELJAqojCgclT5ImWJALmEaOel65HvNBkIhVMNJjFbPj+YhHZi
nk8kpHtHYL0/reY6h1qUPJqWXOe6dQwCZ6OpXA+2lfLbz6f1213pQKx0PyCqPqBN
eK2ZzbG87JcTcGdHyfDrlXkRfmFXPtw1KiIusoBFSRmX0ZCHFhFPNgfUPCoSCka2
XV56qD4MrZB30uKG4P9kYHpHJwIjq1jWMxWPCTWFychEGSaGK9uEMVvvrEJ07Odj
aLFgpgX95SMTsl0Zsn32UHmlakL78sd+LZrTIf2WSXZVjRQ8ntsUyrmDScD7xjVm
lQp2YVC8mlb+95NyNvr3FPeKOYoGllovkE5nfvhbQrB9F2u49EA4llSvGe3azl+n
PfuxMlaOCmRG4pTt4UYSjkMjDEyZj5u/mFTanNtZJznR4kMwoX1+8ExYC9xnYTvZ
1sh8exREeahydqda2y2WvTfXwEqwFa9VXthGhL/KHm/M7wfmZ3/fe45MyuL7XGvq
U+vCb+dEY9/POSMPa7AD
=Os/j
-----END PGP SIGNATURE-----

[Marek Marczykowski-Górecki]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On Wed, May 25, 2016 at 02:48:42PM -0700, Andrew David Wong wrote:
> On 2016-05-25 14:33, john.david.r.smith wrote:
> > hi. is there any code + structure documentation? e.g.: 1) a list of
> > all files associated with a vm + what is stored in them 2) a
> > documentation of data stored for each vm

Take a look here:
https://www.qubes-os.org/doc/template-implementation/
There is a list of disks (and what they are) connected to the VM.

> > 3) source code
> > documentation / documentation of code structure

In addition to what Andrew already pointed out, take a look here:
http://blog.invisiblethings.org/2013/03/21/introducing-qubes-odyssey-framework.html

There is description of concept how repositories are named and what is
where.

> > if there is no such thing, i would propose to add something like
> > this, because it lowers the barrier of entrance for devs to help
> > with the project.
> >
> > -john
> >
>
> All of the developer documentation on qubes-os.org is here:
>
> https://www.qubes-os.org/doc/#for-developers
>
> In particular, take a look here:
>
> https://www.qubes-os.org/doc/system-doc/
>
> And here:
>
> https://www.qubes-os.org/doc/source-code/
>
> However, the qubes-core-admin docs are hosted separately here:
>
> https://qubes-core-admin.readthedocs.io/en/latest/

This applies to upcoming Qubes 4.0 only.



- --
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQEcBAEBCAAGBQJXRjI7AAoJENuP0xzK19csETcH/3VhxkqSLOLg25G+pAV7W5E3
ObEX/k/MRStiYQcNXBUEwPQT+7kb8xst1Ux6A6lQvbL5PJLDn4yxUEaM0pNBxCTc
u2jKxEnzE2z4+0fUtAG1Z/rDhe0uUg//jTy70GAo5sUnoESfj4rD0UgUwTLGNvZX
q9Ru7KKhXl+NdOcjGgGD0tQxZ2yc8otCQgjvsBrxWNhfrCfiVV2GGEhGUAe2z0FI
R0Hgivi/K/X4GRCMAhUhp5voXZdHmn2vYXu6/QIZ5tl9YyZI9re7m21KgcwGGUP+
2+edXS3BQucsQEFvtZ+i9ZUzGpuxMSEFlgzozyNGoaeEUzUrJ8BkT0f0c6Ut8ZA=
=5QWj
-----END PGP SIGNATURE-----

[john.david.r.smith]

thanks to both of you!

looking at https://qubes-core-admin.readthedocs.io/en/latest/ and
https://github.com/kalkin/qubes-core-admin/network, it seems you are
currently rewriting most (all?) of qubes-core-admin.

can you tell me (or tell me where i can find that information) how much
of this is done / how much of the code will probably change?

-john

[Marek Marczykowski-Górecki]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

On Thu, May 26, 2016 at 07:24:21PM +0200, john.david.r.smith wrote:
> thanks to both of you!
>
> looking at https://qubes-core-admin.readthedocs.io/en/latest/ and
> https://github.com/kalkin/qubes-core-admin/network, it seems you are
> currently rewriting most (all?) of qubes-core-admin.

Yes, there is ongoing rewrite of this component.

> can you tell me (or tell me where i can find that information) how much of
> this is done / how much of the code will probably change?

I think the most accurate estimation on process is in tickets for Qubes
4.0:
https://github.com/QubesOS/qubes-issues/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+milestone%3A%22Release+4.0%22+label%3A%22C%3A+core%22

Somehow more high level info is in this particular one:
https://github.com/QubesOS/qubes-issues/issues/1825

But since each of those points is only "finished / not finished" it
isn't very accurate (for example DispVMs, qvm-block and migration tools
are almost completed).

- --
Best Regards,
Marek Marczykowski-Górecki
Invisible Things Lab
A: Because it messes up the order in which people normally read text.
Q: Why is top-posting such a bad thing?
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2

iQEcBAEBCAAGBQJXS3yHAAoJENuP0xzK19csugQH/3gsBdB9hpe90bPDBqwtW7JH
u37m5YrE+jlqbZyjaxTTv7nR7B6L4uJuMycjOQedcii9gqPRqq4qO8yol1OvtA0i
Hyh0tw5p7DREkUCjrB6T33D5rsPPTyIGXB+CiqH96xp73Kxm/RTzQelVFSlDEFCj
BzbV6txr+FPCRcnlpjf9f69pHjCzRaK/frxOmOjiEjFni7eweV2OtKHI9wr2hg+S
8d5WA6K1C0LEogkgifUjKP2PaRetQhYJn1cmfGEvqQDB/7fa1NeJkQIcDPSlZOHG
9YgKw++DwMsac3d9Z3I7uuHSX0289Ey8hQ58b6OXHqJtCT/KaunalEVYyY2KjiI=
=uZf5
-----END PGP SIGNATURE-----