Issue 561360043: Doc: Correct and extend infos about LilyDev setup
|
Created:
5 years, 1 month ago by michael.kaeppler Modified:
5 years, 1 month ago CC:
lilypond-devel_gnu.org Visibility:
Public. |
DescriptionDoc: Correct and extend infos about LilyDev setup
* Adjust filenames, setup description etc. to
match LilyDev 2
* Remove information which is no longer valid
* Describe setup procedure more in detail
Patch Set 1 #
Total comments: 29
Patch Set 2 : Incorporate fixes from Werner and Dan #
Total comments: 10
Patch Set 3 : New adjustments from Werner #
Total comments: 4
Patch Set 4 : Federico's notes, remove section regarding root password (root account will be locked in upcoming L… #MessagesTotal messages: 19
This patch reflects some changes and small fixed that I contributed to LilyDev and which are now in the new release v2. https://github.com/fedelibre/LilyDev/releases
Sign in to reply to this message.
Good work. Needs some revision. https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... File Documentation/contributor/quick-start.itexi (right): https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:94: The zip archive you downloaded containes the raw disk image and containes -> contains https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:152: @q{Extended features: Enable EFI}. Otherwise you won't be ... Enable EFI}; otherwise, ... https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:159: interaction with your mouse pointer on both the host and guest and let ... guest, and let ... https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:188: You can change the password of the @q{dev} user similarly, just call ... similarly; just call ... https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:204: At first you will be prompted for the model of your keyboard. At first, ... https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:205: Press Enter to show further models. In most cases it will be In most cases, ... https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:206: sufficient to choose number 71 (Generic, 105 keys). After that After that, ... https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:207: choose your keyboard layout. Now you can customize the function of Now, ... Do you detect a pattern here? :) https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:208: your AltGr key. Normally you will use the default layout settings, Normally, ... https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:209: so take number 1. The same holds for the question whether you want ... the question of whether ... https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:211: At last you will be asked if you want to configure At last, ... https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:213: Presumably you will not need this, so you can safely type @q{no}. Presumably, ... https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:216: To setup your system language(charset, localized messages etc.), set up https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:228: Finally you should run a setup script. If you're on the command line Finally, ...
Sign in to reply to this message.
Some more nits. Thanks for working on this! https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... File Documentation/contributor/quick-start.itexi (right): https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:28: and the website (also see @ref{Website work}). It is also prepared In documentation, please use two spaces after a full stop that indicates a sentence ending. https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:42: @code{LilyDev-VERSION-debian-vm.zip}. GNU/Linux users are recommended s/@code/@file/ https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:46: create it from the sources located in the /mkosi subdirectory ... in the @code{/mkosi} sub directory... https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:98: extracted the files: (this may take some time) I suggest to put the colon after the parenthesized text. https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:104: For Windows, look for the tools @strong{FCIV} or @strong{certutil} s/@strong/@command/ https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:110: that @q{VBoxManage} is in your PATH or call it from your @code{PATH} https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:114: VBoxManage convertfromraw LilyDev-VERSION-debian-vm.img LilyDev-VERSION-debian-vm.vdi This is too long to be printed in the PDF output without an overfull line. I thus suggest @example VBoxManage convertfromraw LilyDev-VERSION-debian-vm.img \ LilyDev-VERSION-debian-vm.vdi @end example https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:135: least 1 GB of RAM; the more RAM you can spare from your host the 1@dmn{GB} https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:142: @code{~/VirtualBox VMs/NAME}). Click on @q{Use an existing virtual s/@code/@file/ https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:189: @q{passwd} as @q{dev} user, without invoking @q{su}. s/@q{passwd}/@command{passwd}/ s/@q{su}/@command{su}/ https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:200: system configuration. The @q{sudo} tool allows to gain superuser @command{sudo} https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:208: your AltGr key. Normally you will use the default layout settings, @key{AltGr} https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:209: so take number 1. The same holds for the question whether you want s/number 1/number@tie{}1/ https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:212: Ctrl+Alt+Backspace as a shortcut to terminate the X server. @key{Ctrl+Alt+Backspace} https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... Documentation/contributor/quick-start.itexi:229: already, simply type @code{./setup.sh} to run the interactive script s/@code/@command/
Sign in to reply to this message.
LGTM Just two thoughts: 1. I'm not sure why you suggest how to set the root password, as the dev user can get admin privileges via sudo. 2. While keyboard configuration is a step needed for any non-US contributor, reconfiguring the locales should be useful only for translators, unless I miss something. Perhaps you could say that these two configurations are optional.
Sign in to reply to this message.
Incorporate fixes from Werner and Dan
Sign in to reply to this message.
On 2020/01/28 23:58:01, Dan Eble wrote: > Good work. Needs some revision. > > https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... > File Documentation/contributor/quick-start.itexi (right): All done. Dan, many thanks for working through this. I should get some lessons in English punctuation. :)
Sign in to reply to this message.
On 2020/01/29 06:48:43, lemzwerg wrote: > Some more nits. Thanks for working on this! > > https://codereview.appspot.com/561360043/diff/547520043/Documentation/contrib... > File Documentation/contributor/quick-start.itexi (right): > All done. Thank you, Werner!
Sign in to reply to this message.
Next round of nits :-) https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... File Documentation/contributor/quick-start.itexi (left): https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... Documentation/contributor/quick-start.itexi:103: specific option choose @q{Linux 2.6/3.x/4.x (64-bit)}. Is it really '64 bit' in one case and '64-bit' in the other case? https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... File Documentation/contributor/quick-start.itexi (right): https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... Documentation/contributor/quick-start.itexi:46: create it from the sources located in the @code{/mkosi} subdirectory s/@code/@file/. https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... Documentation/contributor/quick-start.itexi:97: On Linux, run the following command in the directory where you've s/you've/you have/ https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... Documentation/contributor/quick-start.itexi:108: As VirtualBox does not support the raw format, you'll have to The GNU documentation guidelines recommend to not use the future tense if possible. s/you'll have/you have/ Please change similar occurrences of future tense, too. https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... Documentation/contributor/quick-start.itexi:118: @warning{You will need a fair amount of disk space (around 30 GB) to 30@tie{}GB https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... Documentation/contributor/quick-start.itexi:176: layout, like e.g. @q{lilzpond} on a German keyboard.} There is an eternal battle whether there is a comma or not after 'e.g.' (in the LilyPond documentation, we *do* use a comma). However, I would reformulate this to ... like @q{lilzpond} on a German keyboard, for example. https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... Documentation/contributor/quick-start.itexi:202: rights temporarily. It will show you a warning message on it's first s/it's/its/ https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... Documentation/contributor/quick-start.itexi:217: To set up your system language(charset, localized messages etc.), s/To set up your system language(charset, localized messages etc.),/ To set up your system language (charset, localized messages, etc.),/ https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... Documentation/contributor/quick-start.itexi:229: Finally, you should run a setup script. If you're on the command line The GNU documentation guidelines recommend to not use contractions, so s/you're/you are/ https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... Documentation/contributor/quick-start.itexi:231: which will set up git and download all the repositories needed to build s/which/that/
Sign in to reply to this message.
New adjustments from Werner
Sign in to reply to this message.
On 2020/01/30 10:12:14, lemzwerg wrote: > Next round of nits :-) > > https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... > File Documentation/contributor/quick-start.itexi (left): > > https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... > Documentation/contributor/quick-start.itexi:103: specific option choose @q{Linux > 2.6/3.x/4.x (64-bit)}. > Is it really '64 bit' in one case and '64-bit' in the other case? No, you're right. It's always '64-bit'. Fixed. > > https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... > File Documentation/contributor/quick-start.itexi (right): > > https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... > Documentation/contributor/quick-start.itexi:46: create it from the sources > located in the @code{/mkosi} subdirectory > s/@code/@file/. Slightly puzzled about this one. You suggested '@code' in your first review, didn't you? > https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... > Documentation/contributor/quick-start.itexi:97: On Linux, run the following > command in the directory where you've > s/you've/you have/ > > https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... > Documentation/contributor/quick-start.itexi:108: As VirtualBox does not support > the raw format, you'll have to > The GNU documentation guidelines recommend to not use the future tense if > possible. > > s/you'll have/you have/ > > Please change similar occurrences of future tense, too. Some future constructs were already there. Done within the section I rewrote. (Hopefully I did not miss any) Adjusting this for the whole chapter is another thing... > > https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... > Documentation/contributor/quick-start.itexi:118: @warning{You will need a fair > amount of disk space (around 30 GB) to > 30@tie{}GB Is there a particular reason why you suggest to use '@tie{}' here and @dmn{GB} for another occurrence of this dimension? Just curious... > > https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... > Documentation/contributor/quick-start.itexi:176: layout, like e.g. @q{lilzpond} > on a German keyboard.} > There is an eternal battle whether there is a comma or not after 'e.g.' (in the > LilyPond documentation, we *do* use a comma). However, I would reformulate this > to > > ... like @q{lilzpond} on a German keyboard, for example. Done. > > https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... > Documentation/contributor/quick-start.itexi:202: rights temporarily. It will > show you a warning message on it's first > s/it's/its/ Urgh. Done. > https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... > Documentation/contributor/quick-start.itexi:217: To set up your system > language(charset, localized messages etc.), > s/To set up your system language(charset, localized messages etc.),/ > To set up your system language (charset, localized messages, etc.),/ Done. > > https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... > Documentation/contributor/quick-start.itexi:229: Finally, you should run a setup > script. If you're on the command line > The GNU documentation guidelines recommend to not use contractions, so > > s/you're/you are/ Done. > > https://codereview.appspot.com/561360043/diff/575590043/Documentation/contrib... > Documentation/contributor/quick-start.itexi:231: which will set up git and > download all the repositories needed to build > s/which/that/ Done.
Sign in to reply to this message.
On 2020/01/29 15:36:59, fedelogy wrote: > LGTM > > Just two thoughts: > > 1. I'm not sure why you suggest how to set the root password, as the dev user > can get admin privileges via sudo. Well, I just thought that it would be bad idea for >any< Linux system to leave the root password unsetted. Maybe the amount of damage that can occur to the host system through the virtualization barrier is small, but at least it minimizes the risk of scrambling your guest system by accident. If you use 'sudo', you have to think about what you type, at least. AFAIK, Ubuntu disables the root account by default, for such reasons. But you could argue that the docs suggest to log in as 'dev', anyway, and if I do want to log in as root, it does not matter if I have to use a password or none. What do you think about disabling the root account? > > 2. While keyboard configuration is a step needed for any non-US contributor, > reconfiguring the locales should be useful only for translators, unless I miss > something. > > Perhaps you could say that these two configurations are optional. One benefit is to have the window manager and the output of localized tools in your own language. But that's not essential, I admit. But I noticed that umlauts are not displayed correctly without configuring the locales. Or am I missing some simpler solution here?
Sign in to reply to this message.
> > Documentation/contributor/quick-start.itexi:46:
> > create it from the sources located in the
> > @code{/mkosi} subdirectory
> > s/@code/@file/.
>
> Slightly puzzled about this one. You suggested
> '@code' in your first review, didn't you?
Yep. A mistake, sorry. '@file' is the right one (or rather, the better one).
> > 30@tie{}GB
>
> Is there a particular reason why you suggest to use
> '@tie{}' here and @dmn{GB} for another occurrence of
> this dimension?
> Just curious...
You are completely right. It should be @dmn{GB} here, too.
Sign in to reply to this message.
And hopefully some final nits. Thanks for your patience! https://codereview.appspot.com/561360043/diff/565550050/Documentation/contrib... File Documentation/contributor/quick-start.itexi (right): https://codereview.appspot.com/561360043/diff/565550050/Documentation/contrib... Documentation/contributor/quick-start.itexi:147: Verify the summary details and click @q{Create}, when you are I think it's better to avoid the comma before 'when'. Maybe it is even better to replace 'when' with 'as soon as' (and still without comma). https://codereview.appspot.com/561360043/diff/565550050/Documentation/contrib... Documentation/contributor/quick-start.itexi:175: @warning{Since the default keyboard layout is US (american). You s/american/American/ s/. You/, you/ https://codereview.appspot.com/561360043/diff/565550050/Documentation/contrib... Documentation/contributor/quick-start.itexi:194: You might need to change the keyboard layout from default US (american) s/american/American/
Sign in to reply to this message.
https://codereview.appspot.com/561360043/diff/565550050/Documentation/contrib... File Documentation/contributor/quick-start.itexi (right): https://codereview.appspot.com/561360043/diff/565550050/Documentation/contrib... Documentation/contributor/quick-start.itexi:208: sufficient to choose number@tie{}71 (Generic, 105 keys). After that, It seems it's not necessarily number 71. I would remove the number. keyboards are sorted alphabetically so "Generic, 105 keys" is enough. Here's what I see: 65. Generic 101-key PC 66. Generic 102-key (Intl) PC 67. Generic 104-key PC 68. Generic 105-key (Intl) PC I've tried 68 but didn't seem to work. I had to go to the GUI settings for the layout, disable system setting and remove the english from the list, then adding new layouts worked fine. (Probably a bug in Debian or XFCE? Honestly, I don't have time nor will to investigate.) Anyway, to me the point is: doing trial and error in the GUI is way better than having to follow the same procedure with dpkg-reconfigure. So I'm not sure adding keyboard-configuration to LilyDev was a good idea. I thought that it would have saved the user from guessing the right layout but that's not the case, so there's no improvement over previous situation AFAICS.
Sign in to reply to this message.
Il giorno gio 30 gen 2020 alle ore 12:18 <michael.kaeppler@googlemail.com> ha scritto: > On 2020/01/29 15:36:59, fedelogy wrote: > > LGTM > > > > Just two thoughts: > > > > 1. I'm not sure why you suggest how to set the root password, as the > dev user > > can get admin privileges via sudo. > > Well, I just thought that it would be bad idea for >any< Linux system > to leave the root password unsetted. Maybe the amount of damage that > can occur to the host system through the virtualization barrier is > small, > but at least it minimizes the risk of scrambling your guest system by > accident. If you use 'sudo', you have to think about what you type, at > least. > AFAIK, Ubuntu disables the root account by default, for such reasons. > But you could argue that the docs suggest to log in as 'dev', anyway, > and if I do want to log in as root, it does not matter if I have to use > a password or none. > What do you think about disabling the root account? > > I see that it's possible to log in as root user without any password _even in the virtual machine_. Not good. I used the --password="" in the Makefile to avoid the step to set the password when starting the container with systemd-nspawn. In mkosi manual I read: --password= > > : Set the password of the root user. By default the root account is > locked. If this option is not used but a file mkosi.rootpw exists in the > local directory the root password is automatically read from it. > So we may remove the --password option to keep the root account disabled and use the mkosi.rootpw to set the password. I will test this and hopefully include it in LilyDev v3.
Sign in to reply to this message.
Am 30.01.2020 um 15:08 schrieb Federico Bruni: > I see that it's possible to log in as root user without any password _even > in the virtual machine_. Not good. That was my point. > I used the --password="" in the Makefile to avoid the step to set the > password when starting the container with systemd-nspawn. > > In mkosi manual I read: > > --password= >> : Set the password of the root user. By default the root account is >> locked. If this option is not used but a file mkosi.rootpw exists in the >> local directory the root password is automatically read from it. >> > So we may remove the --password option to keep the root account disabled > and use the mkosi.rootpw to set the password. > I will test this and hopefully include it in LilyDev v3. I read the manual differently. I think mkosi.rootpw is just the 'file alternative' to the command line, like mkosi.container, etc. So if you set the password in mkosi.rootpw, the root account will be active, too. But I haven't tested this. IIUC, we could change the root login shell to /sbin/nologin to lock the root account in the post-install script. What do you think? Cheers, Michael
Sign in to reply to this message.
Il giorno ven 31 gen 2020 alle ore 09:07 Michael Käppler <xmichael-k@web.de> ha scritto: > Am 30.01.2020 um 15:08 schrieb Federico Bruni: > > I see that it's possible to log in as root user without any password > _even > > in the virtual machine_. Not good. > That was my point. > > I used the --password="" in the Makefile to avoid the step to set the > > password when starting the container with systemd-nspawn. > > > > In mkosi manual I read: > > > > --password= > >> : Set the password of the root user. By default the root account is > >> locked. If this option is not used but a file mkosi.rootpw exists in the > >> local directory the root password is automatically read from it. > >> > > So we may remove the --password option to keep the root account disabled > > and use the mkosi.rootpw to set the password. > > I will test this and hopefully include it in LilyDev v3. > I read the manual differently. I think mkosi.rootpw is just the 'file > alternative' to > the command line, like mkosi.container, etc. So if you set the password > in mkosi.rootpw, > the root account will be active, too. But I haven't tested this. > You're right. I read too quickly and thought that this could be a kind of custom user file, while it's part of the files used to build the image. > IIUC, we could change the root login shell to /sbin/nologin to lock the > root account > in the post-install script. What do you think? > > I have a second thought about this. The whole point of setting a blank root password was that systemd-nspawn required a root login (at least 2 years ago). In fact in the README I suggested to log in as root and then change to dev. But I see that I can log in as dev without any problem (systemd version 243). Can you confirm you can log in as dev in the container? So I'll just remove the --password="" from the Makefile and change the README accordingly.
Sign in to reply to this message.
Am 31.01.2020 um 10:07 schrieb Federico Bruni: > > > I have a second thought about this. > The whole point of setting a blank root password was that > systemd-nspawn required a root login (at least 2 years ago). In fact > in the README I suggested to log in as root and then change to dev. > But I see that I can log in as dev without any problem (systemd > version 243). Can you confirm you can log in as dev in the container? > > So I'll just remove the --password="" from the Makefile and change the > README accordingly. Did not test the container, but for the VM image this does work. I can log in as dev and the root account is locked. Cheers, Michael
Sign in to reply to this message.
Federico's notes, remove section regarding root password (root account will be locked in upcoming LilyDev releases)
Sign in to reply to this message.
|
