atomic-server icon indicating copy to clipboard operation
atomic-server copied to clipboard

generated .env file contains typo and lack format notice

Open jonassmedegaard opened this issue 3 years ago • 1 comments

Command atomic-server setup-env generates a file .env. Nice!

That generated file contains a typo on first line, however: runnign -> running.

Also, and more important, it is undocumented how exactly to format entries in that file, and where it belongs (it is stored in current directory, wherever that might happen to be).

I guess that the file is specifically tailored for use with a systemd service unit file, and therefore recommend to state explicitly some notes about that.

The following is the full text of a default file that I (modulo a typo of my own) shipped with my draft packaging until I noticed this feature for generating a more rich file:

# This is a systemd EnvironmentFile for atomic-server.
# For supported variables and values, see man page atomic-server(8).
# For file syntax, see man page systemd.exec(5) section ENVIRONMENT.

I suggest to include the above text at the top of the generated content, replacing at least the first line of currently generated content.

While at it, I also suggest to wrap lines at 72 chars (or at most at 78 chars), since some editors (I am told emacs is among those) can be annoying to use with very long lines.

  • [ ] 72 chars max width
  • [ ] Typo in first line
  • [ ] More info (systemd)

jonassmedegaard avatar Mar 25 '22 08:03 jonassmedegaard

Good points, I'll edit your post and include a todo checklist

joepio avatar Mar 25 '22 08:03 joepio