From ab76b1b8236ab57fc4e5e964f5c1c88923d24939 Mon Sep 17 00:00:00 2001 From: Matthias Clasen <mclasen@redhat.com> Date: Wed, 29 Feb 2012 08:52:10 -0500 Subject: [PATCH] Add some more draft documentation This is just the bones for now, waiting for Colin to provide the meat. --- gnomeos/README-install.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/gnomeos/README-install.md b/gnomeos/README-install.md index 686f2375..7be3393a 100644 --- a/gnomeos/README-install.md +++ b/gnomeos/README-install.md @@ -65,3 +65,39 @@ currently assumes that the repository is in the current directory. In the future this will be part of a system administrator oriented utility (e.g. "ostreeadm"). +Next steps +---------- + +Now that you have your OSTree install and know how to update +it, you probably want to do something useful with it. OSTrees +main mission is to assist developers and testers, so lets explain +how it lets a tester isolate a problem. + +Bisecting +--------- + +Say you've updated your OSTree installation, and after booting +it, you notice a new problem. What now ? You probably want to +identify exactly when this problem was introduced. A good technique +for doing so is known as 'bisection'. Here is how it works: + +[...sadly I don't know how to do this with OSTree] + +Once you have identified the binary revision that introduced the +problem, you can go one step further. OSTree stores the source +revisions that each commit has been built from, so you can retrieve +the exact source changes that are likely responsible for +the problem you've just tracked down. + +[...fill me in] + +Local changes +------------- + +If are a developer, at this point you may try your hand at fixing +the problem in the source. Of course, you want to build the module +with your change, and add it to your OSTree installation to verify +that it fixes the problem. Here is how: + +[...?] +