cemu-project_Mirror/Cemu-2024-03-05
1
0
Fork 0
Code Issues 224 Pull requests 11 Projects Releases Packages Wiki Activity

Manpage #565

Open
jn64 wants to merge 2 commits from jn64/manpage into main
pull from: jn64/manpage
merge into: cemu-project_Mirror:main
Conversation 4 Commits 2 Files changed 3 +229
jn64 commented 2022-12-09 04:14:12 -03:00 (Migrated from github.com)
Copy link

See commit messages for details

Todo:

  • AUTHORS — I took it from the About dialog of Cemu. Some manpages include "and contributors" or similar wording, or simply omit AUTHORS.
    • Actually reading man-pages(7) says this section is strongly discouraged. Will remove unless its wanted
  • Copyright statement ­— I didn't find a definitive copyright statement in README.md or source files. Also optional.
  • BUGS — should be REPORTING BUGS
  • FILES — should list locations of config files (what about portable vs non-portable?)
  • I don't know what the --act-url argument "URL prefix for account server" is (protocol? hostname or part of hostname? fully formed URL?)
  • Do macOS GUI apps include man pages?
See commit messages for details Todo: - ~~AUTHORS — I took it from the *About* dialog of Cemu. Some manpages include "and contributors" or similar wording, or simply omit AUTHORS.~~ - Actually reading man-pages(7) says this section is **strongly discouraged**. Will remove unless its wanted - Copyright statement ­— I didn't find a definitive copyright statement in README.md or source files. Also optional. - BUGS — should be REPORTING BUGS - FILES — should list locations of config files (what about portable vs non-portable?) - I don't know what the `--act-url` argument "URL prefix for account server" is (protocol? hostname or part of hostname? fully formed URL?) - Do macOS GUI apps include man pages?
👍 1
Tachi107 (Migrated from github.com) requested changes 2022-12-09 12:15:57 -03:00
Tachi107 (Migrated from github.com) left a comment
Copy link

Instead of shipping a pre-generated artefact, could you please add a man target to the CMake build system instead?

Instead of shipping a pre-generated artefact, could you please add a `man` target to the CMake build system instead?
Tachi107 commented 2022-12-09 12:38:29 -03:00 (Migrated from github.com)
Copy link

First of all thank you for bringing this up! man pages are underrated :)

  • AUTHORS — I took it from the About dialog of Cemu. Some manpages include "and contributors" or similar wording, or simply omit AUTHORS.

    • Actually reading man-pages(7) says this section is strongly discouraged. Will remove unless its wanted

I personally don't fully agree with the opinion expressed in the man-pages(7) manual, and in fact other manuals such as mdoc(7) or scdoc(5) do not discourage this at all.

  • Copyright statement ­— I didn't find a definitive copyright statement in README.md or source files. Also optional.

Cemu is licensed under the MPL-2.0

  • FILES — should list locations of config files (what about portable vs non-portable?)

I'd only describe the files used in "non portable" mode, and then mention that in portable mode everything is more or less dumped in the binary directory.

First of all thank you for bringing this up! `man` pages are underrated :) > * ~AUTHORS — I took it from the _About_ dialog of Cemu. Some manpages include "and contributors" or similar wording, or simply omit AUTHORS.~ > > * Actually reading man-pages(7) says this section is **strongly discouraged**. Will remove unless its wanted I personally don't fully agree with the opinion expressed in the [`man-pages(7)`](https://man7.org/linux/man-pages/man7/man-pages.7.html) manual, and in fact other manuals such as [`mdoc(7)`](https://man.openbsd.org/mdoc.7) or [`scdoc(5)`](https://git.sr.ht/~sircmpwn/scdoc/tree/master/item/scdoc.5.scd) do not discourage this at all. > * Copyright statement ­— I didn't find a definitive copyright statement in README.md or source files. Also optional. [Cemu is licensed under the MPL-2.0](https://github.com/cemu-project/Cemu#license) > * FILES — should list locations of config files (what about portable vs non-portable?) I'd only describe the files used in "non portable" mode, and then mention that in portable mode everything is more or less dumped in the binary directory.
jn64 commented 2022-12-09 13:56:56 -03:00 (Migrated from github.com)
Copy link

Instead of shipping a pre-generated artefact, could you please add a man target to the CMake build system instead?

I'm not including the actual manpage. The 2nd commit is just for preview here.

But I can't do the CMake thing, because

  1. I don't know how, and don't intend to learn, and
  2. As mentioned in the first commit, this would add a build dependency on pandoc (or whatever intermediate format chosen), which should be decided on first.

Cemu is licensed under the MPL-2.0

I know, I was asking for an existing statement (if any) like Copyright (c) XXXX-YYYY Cemu McCemuface

> Instead of shipping a pre-generated artefact, could you please add a `man` target to the CMake build system instead? I'm not including the actual manpage. The 2nd commit is just for preview here. But I can't do the CMake thing, because 1. I don't know how, and don't intend to learn, and 2. As mentioned in the first commit, this would add a build dependency on pandoc (or whatever intermediate format chosen), which should be decided on first. > Cemu is licensed under the MPL-2.0 I know, I was asking for an existing statement (if any) like `Copyright (c) XXXX-YYYY Cemu McCemuface`
Tachi107 commented 2022-12-09 14:04:13 -03:00 (Migrated from github.com)
Copy link

Il giorno ven 9 dic 2022 alle 08:57:06 -08:00:00, jn64
@.***> ha scritto:

I'm not including the actual manpage. The 2nd commit is just for
preview here.

Oh ok, I wasn't sure about that, thanks for the clarification :)

But I can't do the CMake thing, because

I don't know how, and don't intend to learn, and As mentioned in the
first commit, this would add a build dependency on pandoc (or
whatever intermediate format chosen), which should be decided on
first.

No worries, I can do it instead (either in a follow-up patch or by
posting a diff here). Also, the intermediate format processor chosen
doesn't have to be a hard build dependency; I'd first check if pandoc
(or whatever) is available, and add the man target only if it is.

--
OpenPGP key: 66DE F152 8299 0C21 99EF A801 A8A1 28A8 AB1C EE49

Il giorno ven 9 dic 2022 alle 08:57:06 -08:00:00, jn64 ***@***.***> ha scritto: > I'm not including the actual manpage. The 2nd commit is just for > preview here. > Oh ok, I wasn't sure about that, thanks for the clarification :) > But I can't do the CMake thing, because > > I don't know how, and don't intend to learn, and As mentioned in the > first commit, this would add a build dependency on pandoc (or > whatever intermediate format chosen), which should be decided on > first. No worries, I can do it instead (either in a follow-up patch or by posting a diff here). Also, the intermediate format processor chosen doesn't have to be a hard build dependency; I'd first check if pandoc (or whatever) is available, and add the man target only if it is. -- OpenPGP key: 66DE F152 8299 0C21 99EF A801 A8A1 28A8 AB1C EE49
jonbarrow commented 2023-06-21 20:51:40 -04:00 (Migrated from github.com)
Copy link

I don't know what the --act-url argument "URL prefix for account server" is (protocol? hostname or part of hostname? fully formed URL?)

It's supposed to be a fully formed URL pointing to the NNID API server, such as https://account.nintendo.net

--ecs-url also exists for a similar purpose, for pointing to the eCommerce SOAP server + path, such as https://ecs.wup.shop.nintendo.net/ecs/services/ECommerceSOAP, which used for getting title tickets and other metadata used during title installation

cd3fe0685f/src/config/LaunchSettings.cpp (L179-L187)

Though last time I checked these arguments haven't been working for a long time (since before Cemu 2.0 even came out), and seem to have been replaced with other config options?

cd3fe0685f/src/config/LaunchSettings.cpp (L279-L282)

> I don't know what the --act-url argument "URL prefix for account server" is (protocol? hostname or part of hostname? fully formed URL?) It's supposed to be a fully formed URL pointing to the NNID API server, such as `https://account.nintendo.net` `--ecs-url` also exists for a similar purpose, for pointing to the eCommerce SOAP server + path, such as `https://ecs.wup.shop.nintendo.net/ecs/services/ECommerceSOAP`, which used for getting title tickets and other metadata used during title installation https://github.com/cemu-project/Cemu/blob/cd3fe0685faba2e631dcc7a1428f085c9fc29802/src/config/LaunchSettings.cpp#L179-L187 Though last time I checked these arguments haven't been working for a long time (since before Cemu 2.0 even came out), and seem to have been replaced with other config options? https://github.com/cemu-project/Cemu/blob/cd3fe0685faba2e631dcc7a1428f085c9fc29802/src/config/LaunchSettings.cpp#L279-L282
This pull request can be merged automatically.
You are not authorized to merge this pull request.
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin jn64/manpage:jn64/manpage
git checkout jn64/manpage

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git checkout main
git merge --no-ff jn64/manpage
git checkout jn64/manpage
git rebase main
git checkout main
git merge --ff-only jn64/manpage
git checkout jn64/manpage
git rebase main
git checkout main
git merge --no-ff jn64/manpage
git checkout main
git merge --squash jn64/manpage
git checkout main
git merge --ff-only jn64/manpage
git checkout main
git merge jn64/manpage
git push origin main
Sign in to join this conversation.
Reviewers
No reviewers
Tachi107
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: cemu-project_Mirror/Cemu-2024-03-05#565
No description provided.
Delete branch "jn64/manpage"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?