gdamjan / secure-boot

UEFI SecureBoot for ArchLinux
58 stars 3 forks source link

create manpage #15

Closed a1lu closed 3 years ago

a1lu commented 3 years ago

I would like to propose this man page.

I wrote it in markdown (secure-boot-man.md) and generated the secure-boot.1 man page with go-md2man (from community repo)

go-md2man --in secure-boot-man.md --out secure-boot.1
man ./secure-boot.1

Todos

gdamjan commented 3 years ago

wow, thanks a lot

Todos

* are we section 1 or section 8

I would say section 8.

* do we want to keep the .md file and the man page

I guess the source repo should have the .md file only, and we can compile the man page in the PKGBUILD. If you agree, remove the man page and I'll update the PKGBUILD

* create a `doc` dir?

no need for a single file. if we grow more docs, then we can think about it.

* list all configuration options in `OPTIONS`?

the man page should be as comprehensive as possible. I'm fine to merge it even in a lesser form, and we can evolve it from there.

a1lu commented 3 years ago
* do we want to keep the .md file and the man page

I guess the source repo should have the .md file only, and we can compile the man page in the PKGBUILD. If you agree, remove the man page and I'll update the PKGBUILD

We can do this, but that would add the go-md2man package as a build dependency only to create the manpage.

gdamjan commented 3 years ago

We can do this, but that would add the go-md2man package as a build dependency only to create the manpage.

it's a 2.7mb compiled package from [community], without any dependencies, and we'll be adding it as a makedeps - I say it's fine.

a1lu commented 3 years ago

Alright, I think this commit should fix all open issues. If you are fine with it I'll squash them and remove the WIP tag.

a1lu commented 3 years ago

I squashed the commits and it's fine to merge from my side.

gdamjan commented 3 years ago

ps. you don't need to squash the commits, in the end I'll squash-merge them

a1lu commented 3 years ago

ps. you don't need to squash the commits, in the end I'll squash-merge them

Good to know github does this too. I'm more used to gitlab.

gdamjan commented 3 years ago

thanks