Hello,
according to our road map (http://genode.org/about/road-map), the upcoming Genode version 15.05 will be accompanied with comprehensive documentation. The work on this documentation is in full swing and can be tracked at the corresponding Git repository:
https://github.com/nfeske/genode-manual
A snapshot of the current version is available as PDF at:
http://genode.org/files/53bcb8e33fe6602fed25edc3c7b922c5/manual-2015-03-06.p...
So far, the work on the following chapters is completed already:
3. Architecture 4. Components 6. System configuration 8. Under the hood
I would greatly appreciate feedback from the community about those chapters - be it in the form of minor spelling or grammar fixes, suggestions for additional topics you wish to see covered, hints about misleading paragraphs, or any other concerns that you may have.
Cheers Norman
Norman,
I didn't have a deep look into the manual yet. However, I want to point that *I highly appreciate your work and effort you've already put into this*. Not to mention the work and efforts of all the people that are and have been involved with the coding of Genode in general: *Thanks a lot and keep on with it!*
Don't get me wrong: I don't think you require a motivational speech. I just wanna be sure you know that your work is being appreciated.
That being said: Have a nice weekend.
Cheers Johannes
On Fri, 06 Mar 2015 16:22:16 +0100 Norman Feske <norman.feske@...1...> wrote:
Hello,
according to our road map (http://genode.org/about/road-map), the upcoming Genode version 15.05 will be accompanied with comprehensive documentation. The work on this documentation is in full swing and can be tracked at the corresponding Git repository:
https://github.com/nfeske/genode-manual
A snapshot of the current version is available as PDF at:
http://genode.org/files/53bcb8e33fe6602fed25edc3c7b922c5/manual-2015-03-06.p...
So far, the work on the following chapters is completed already:
- Architecture
- Components
- System configuration
- Under the hood
I would greatly appreciate feedback from the community about those chapters - be it in the form of minor spelling or grammar fixes, suggestions for additional topics you wish to see covered, hints about misleading paragraphs, or any other concerns that you may have.
Cheers Norman
Am Freitag, 6. März 2015, 16:22:16 schrieb Norman Feske:
Hi Norman,
Hello,
according to our road map (http://genode.org/about/road-map), the upcoming Genode version 15.05 will be accompanied with comprehensive documentation. The work on this documentation is in full swing and can be tracked at the corresponding Git repository:
https://github.com/nfeske/genode-manual
A snapshot of the current version is available as PDF at:
http://genode.org/files/53bcb8e33fe6602fed25edc3c7b922c5/manual-2015-03 -06.pdf
So far, the work on the following chapters is completed already:
- Architecture
- Components
- System configuration
- Under the hood
I would greatly appreciate feedback from the community about those chapters - be it in the form of minor spelling or grammar fixes, suggestions for additional topics you wish to see covered, hints about misleading paragraphs, or any other concerns that you may have.
This is really great to see such comprehensive documentation!
My experience with such documentation (considering that I am maintaining a 1500+ design documentation of the Linux kernel) is that references to the code are helpful. For example: when you talk about a capability in section 3.1, just add a hint which C++ object such capability is stored in. With this, a reader now as an entry into the code and can start to understand the code.
Note, I am not looking for comprehensive code snippets -- just a reference to the code structs / objects.
Cheers Norman
Ciao Stephan
Thank you for the encouraging words! :-)
Cheers Norman
On 03/06/2015 04:42 PM, Johannes Schlatow wrote:
Norman,
I didn't have a deep look into the manual yet. However, I want to point that *I highly appreciate your work and effort you've already put into this*. Not to mention the work and efforts of all the people that are and have been involved with the coding of Genode in general: *Thanks a lot and keep on with it!*
Don't get me wrong: I don't think you require a motivational speech. I just wanna be sure you know that your work is being appreciated.
That being said: Have a nice weekend.
Cheers Johannes
Hello Norman,
First of all thank you for creating such a document and giving it to the community. As I started familiarizing myself with Genode about a month ago, your timing is impeccable :)
On 03/06/2015 04:22 PM, Norman Feske wrote:
I would greatly appreciate feedback from the community about those chapters - be it in the form of minor spelling or grammar fixes, suggestions for additional topics you wish to see covered, hints about misleading paragraphs, or any other concerns that you may have.
I have reviewed the entire document expect for the NOVA deferred page-fault handling section in the "Under the hood" chapter. Most changes are typo fixes and other minor stylistic corrections. Besides that I included some suggestions for alternative wording.
You can find the changes incorporated into the document in the review branch at [1]. Please let me know if you would like me to submit the changes in a different form (e.g. pull request) or make other adjustments.
Cheers, Adrian
[1] - https://github.com/codelabs-ch/genode-manual/tree/review
Hi Norman,
It is great work,I just start reading and I can see clearly the big effort that you had putted there. I have some thing in my mind, I believe (at least in my case) that any one asked question here in the mailing list because he could not find clear answer for his problem in the previous documentation , so I think to have a look at the messages here and try to fill all the gaps that people asked about it will be very nice thing.
Finally ,I would like to thank you and all the guys who work with you to provide us such a worth work.
Best, On Mar 6, 2015 3:19 PM, "Norman Feske" <norman.feske@...1...> wrote:
Hello,
according to our road map (http://genode.org/about/road-map), the upcoming Genode version 15.05 will be accompanied with comprehensive documentation. The work on this documentation is in full swing and can be tracked at the corresponding Git repository:
https://github.com/nfeske/genode-manual
A snapshot of the current version is available as PDF at:
http://genode.org/files/53bcb8e33fe6602fed25edc3c7b922c5/manual-2015-03-06.p...
So far, the work on the following chapters is completed already:
- Architecture
- Components
- System configuration
- Under the hood
I would greatly appreciate feedback from the community about those chapters - be it in the form of minor spelling or grammar fixes, suggestions for additional topics you wish to see covered, hints about misleading paragraphs, or any other concerns that you may have.
Cheers Norman
-- Dr.-Ing. Norman Feske Genode Labs
http://www.genode-labs.com · http://genode.org
Genode Labs GmbH · Amtsgericht Dresden · HRB 28424 · Sitz Dresden Geschäftsführer: Dr.-Ing. Norman Feske, Christian Helmuth
Dive into the World of Parallel Programming The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/ _______________________________________________ genode-main mailing list genode-main@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/genode-main
Hi Adrian,
wow! Thank you very much for this thorough review. :-) I reviewed your patches and incorporated them almost unmodified. Also, thank you for the useful remarks (marked with XXX). I will revisit each of them at a later stage.
Because the number of your corrections is quite substantial, I generated a new version of the document with all the fixes in place:
http://genode.org/files/53bcb8e33fe6602fed25edc3c7b922c5/manual-2015-03-09.p...
Of course, the new version is also available at my repository:
https://github.com/nfeske/genode-manual/commits/master
I am happy that you found the documentation valuable and greatly appreciate your contribution to it.
Cheers Norman
On 03/09/2015 11:08 AM, Adrian-Ken Rueegsegger wrote:
Hello Norman,
First of all thank you for creating such a document and giving it to the community. As I started familiarizing myself with Genode about a month ago, your timing is impeccable :)
On 03/06/2015 04:22 PM, Norman Feske wrote:
I would greatly appreciate feedback from the community about those chapters - be it in the form of minor spelling or grammar fixes, suggestions for additional topics you wish to see covered, hints about misleading paragraphs, or any other concerns that you may have.
I have reviewed the entire document expect for the NOVA deferred page-fault handling section in the "Under the hood" chapter. Most changes are typo fixes and other minor stylistic corrections. Besides that I included some suggestions for alternative wording.
You can find the changes incorporated into the document in the review branch at [1]. Please let me know if you would like me to submit the changes in a different form (e.g. pull request) or make other adjustments.
Cheers, Adrian
[1] - https://github.com/codelabs-ch/genode-manual/tree/review
Norman- I'm about to dive into your new documentation... its looking great! I like that you start with section 1.1 "Universal Truths"
sensing the inclination of your document is to start from a philosophical perspective and sec 1.1 is still marked as "ToDo": may I mention the main thesis of "Finite and Infinite Games" by James P. Carse http://www.jamescarse.com/jc/Welcome.html: "*There are at least two kinds of games. One could be called* *finite, the other infinite.*" ... and I would gather the Genode OS framework is a best attempt at the infinite kind.
I'll send more feedback once I've had a chance to absorb. _peter
On Sat, Mar 7, 2015 at 4:32 AM, Norman Feske <norman.feske@...1...> wrote:
Thank you for the encouraging words! :-)
Cheers Norman
On 03/06/2015 04:42 PM, Johannes Schlatow wrote:
Norman,
I didn't have a deep look into the manual yet. However, I want to point
that *I highly appreciate your work and effort you've already put into this*. Not to mention the work and efforts of all the people that are and have been involved with the coding of Genode in general: *Thanks a lot and keep on with it!*
Don't get me wrong: I don't think you require a motivational speech. I
just wanna be sure you know that your work is being appreciated.
That being said: Have a nice weekend.
Cheers Johannes
Dive into the World of Parallel Programming The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/ _______________________________________________ genode-main mailing list genode-main@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/genode-main
Hallo,
following up on our discussion one month ago, I have produced a new version of the document:
http://genode.org/files/53bcb8e33fe6602fed25edc3c7b922c5/manual-2015-03-31.p...
In the meanwhile, it received the following new chapters:
2. Getting started 5. Development 7. Functional specification
Content-wise it covers what I originally had in mind. Only the introduction is yet to be written and a few cross references are still missing. Do you miss a specific topic or find any part of the document too hard to swallow? Please let me know.
Cheers Norman
On 03/06/2015 04:22 PM, Norman Feske wrote:
Hello,
according to our road map (http://genode.org/about/road-map), the upcoming Genode version 15.05 will be accompanied with comprehensive documentation. The work on this documentation is in full swing and can be tracked at the corresponding Git repository:
https://github.com/nfeske/genode-manual
A snapshot of the current version is available as PDF at:
http://genode.org/files/53bcb8e33fe6602fed25edc3c7b922c5/manual-2015-03-06.p...
So far, the work on the following chapters is completed already:
- Architecture
- Components
- System configuration
- Under the hood
I would greatly appreciate feedback from the community about those chapters - be it in the form of minor spelling or grammar fixes, suggestions for additional topics you wish to see covered, hints about misleading paragraphs, or any other concerns that you may have.
Cheers Norman
I'm reading the documentation to get a better understanding of Genode. I am a native English speaker, and I like most of what I've read so far, however I have found a few errors. The most frequent error is incorrect punctuation (e.g. placing commas where they don't belong). Though this is a minor issue, it would be nice to get it fixed. I would do it myself as I read the documentation if I could edit the PDF. The biggest error that I have come across so far is on page 44 of manual-2015-03-31: "Genode does hardly abstract from physical resources." You could change it to something like "Genode doesn't abstract from physical resources." Overall, I am impressed with the documentation. You clearly have a very good grasp of the English language--better than most people who speak English as their first language. The documentation is very enlightening. Thank you.
On Tue, Mar 31, 2015 at 5:20 PM, Norman Feske <norman.feske@...1...> wrote:
Hallo,
following up on our discussion one month ago, I have produced a new version of the document:
http://genode.org/files/53bcb8e33fe6602fed25edc3c7b922c5/manual-2015-03-31.p...
In the meanwhile, it received the following new chapters:
- Getting started
- Development
- Functional specification
Content-wise it covers what I originally had in mind. Only the introduction is yet to be written and a few cross references are still missing. Do you miss a specific topic or find any part of the document too hard to swallow? Please let me know.
Cheers Norman
On 03/06/2015 04:22 PM, Norman Feske wrote:
Hello,
according to our road map (http://genode.org/about/road-map), the upcoming Genode version 15.05 will be accompanied with comprehensive documentation. The work on this documentation is in full swing and can be tracked at the corresponding Git repository:
https://github.com/nfeske/genode-manual
A snapshot of the current version is available as PDF at:
http://genode.org/files/53bcb8e33fe6602fed25edc3c7b922c5/manual-2015-03-06.p...
So far, the work on the following chapters is completed already:
- Architecture
- Components
- System configuration
- Under the hood
I would greatly appreciate feedback from the community about those chapters - be it in the form of minor spelling or grammar fixes, suggestions for additional topics you wish to see covered, hints about misleading paragraphs, or any other concerns that you may have.
Cheers Norman
-- Dr.-Ing. Norman Feske Genode Labs
http://www.genode-labs.com · http://genode.org
Genode Labs GmbH · Amtsgericht Dresden · HRB 28424 · Sitz Dresden Geschäftsführer: Dr.-Ing. Norman Feske, Christian Helmuth
Dive into the World of Parallel Programming The Go Parallel Website, sponsored by Intel and developed in partnership with Slashdot Media, is your hub for all things parallel software development, from weekly thought leadership blogs to news, videos, case studies, tutorials and more. Take a look and join the conversation now. http://goparallel.sourceforge.net/ _______________________________________________ genode-main mailing list genode-main@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/genode-main
Hello Bob,
nice to see you after such a long time. I am happy about your feedback!
On 04/27/2015 06:47 AM, Nobody III wrote:
I'm reading the documentation to get a better understanding of Genode. I am a native English speaker, and I like most of what I've read so far, however I have found a few errors. The most frequent error is incorrect punctuation (e.g. placing commas where they don't belong). Though this is a minor issue, it would be nice to get it fixed. I would do it myself as I read the documentation if I could edit the PDF.
The PDF is created from the document "source code" found here:
https://github.com/nfeske/genode-manual
You can clone it as a regular Git repository:
git clone https://github.com/nfeske/genode-manual.git
The textual content has the form of the plain text files in the manual/ subdirectory. If you have any fixes, you may edit those text files and send me a diff. I am very thankful for such corrections. :-)
The biggest error that I have come across so far is on page 44 of manual-2015-03-31: "Genode does hardly abstract from physical resources." You could change it to something like "Genode doesn't abstract from physical resources."
Thank you.
Norman
-
Adrian-Ken Rueegsegger -
Johannes Schlatow -
Mohammad Hamad -
Nobody III -
Norman Feske -
Peter Lindener -
Stephan Mueller