WIP: README.md: Expand Usage section #17
Conversation
|
@agustinhenze, @stefwalter here is some more documentation for you to try. I'll be updating this more as I go along. Posting now to possibly unblock your progress. Would be happy to hear any feedback. |
|
Awesome PR :). I've just tried it and the kernel is building! Tomorrow I'll take a look closely |
|
I'd love to write the first smoke test doing the same thing that I did following the README but it is too slow. I don't know if travis has caching and not sure if it will be useful 🤔. Maybe tweaking the config and not building a huge kernel like mine (the debian default he) will be doable. Tomorrow I'll give a try. |
spbnick
force-pushed
the
expand_usage_doc
branch
from
3b45df3 to
cb8b8f1
Compare
|
@agustinhenze, I expanded the Usage section some more. Could you take a look and tell me if it makes sense? Thanks! |
|
Alright, I assume everyone had a chance to take a look at this and simply doesn't have any comments :) Merging this tomorrow morning, if nobody objects. |
| time you want to do something, then discard the file after the task is | ||
| complete. Note that reusing a configuration file with state added can break | ||
| some commands in unexpected ways. That includes repeating a previous command | ||
| after the next command in the workflow has already ran. |
There was a problem hiding this comment.
It is a state-config file like the light is a wave-particle 🤦♂️. Sorry I couldn't avoid it
There was a problem hiding this comment.
Ha-ha, indeed 😄. We have a FIXME somewhere, but now it's in #27 as well.
| specific host was picked. For use in `<whiteboard>`. | ||
| * `##HOSTNAMETAG##` | ||
| - An XML fragment limiting the job to a specific host, or empty string if | ||
| no specific host was picked. For use in `<hostRequires>`. |
There was a problem hiding this comment.
It'd be great if you follow the same approach than above and put an example of the template here. Honestly I didn't get it at first, tomorrow I'll read it again and see if I get it.
There was a problem hiding this comment.
Good idea. I added the example. However, I had to strip quite a lot of stuff from it, so it won't work (not that it would work outside Red Hat anyway), but it can serve as an illustration. Hope that helps.
spbnick
force-pushed
the
expand_usage_doc
branch
from
cb8b8f1 to
25b8fc6
Compare
|
Merged with the template example. Thank you for the review, Agustin! |
| `URL_PREFIX` would be the string to add to prepend the filenames with | ||
| (together with a slash `/`) to construct the URLs the files will be reachable | ||
| at. The resulting URLs will be passed to other commands, such as `run`, via | ||
| the saved state in the configuration file. |
There was a problem hiding this comment.
This paragraph is a little bit unclear surely because the command interface is tricky. If I understand correctly, you can use the simple "cp" only if the beaker-server is running on the same host that skt?
| Here, `<REPORTER_TYPE>` would be the reporter type: either `stdio`, or `mail`, | ||
| and `<REPORTER_PARAMS>` would be the type-specific parameters in JSON | ||
| representation. The `stdio` reporter doesn't need any parameters, so you can | ||
| just pass an empty object, like this: |
No description provided.