Page MenuHomeFreeBSD

Document USES=guile.
ClosedPublic

Authored by andrew_tao173.riddles.org.uk on Aug 1 2023, 7:29 PM.
Tags
None
Referenced Files
Unknown Object (File)
Thu, Jun 13, 3:09 AM
Unknown Object (File)
May 19 2024, 12:01 PM
Unknown Object (File)
Apr 29 2024, 11:49 AM
Unknown Object (File)
Apr 26 2024, 1:19 AM
Unknown Object (File)
Apr 22 2024, 1:38 AM
Unknown Object (File)
Apr 22 2024, 1:26 AM
Unknown Object (File)
Apr 22 2024, 1:14 AM
Unknown Object (File)
Apr 22 2024, 12:10 AM

Details

Summary

Document USES=guile in the porter's handbook.

See D40194 for the code changes that this applies to.

Diff Detail

Repository
R9 FreeBSD doc repository
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Looks really great!

From the doc side is ok, I'm gonna add ports team too

documentation/content/en/books/porters-handbook/special/_index.adoc
4444

Can you please remove this extra line?

4477

Can you please remove this extra line?

pauamma_gundo.com added inline comments.
documentation/content/en/books/porters-handbook/special/_index.adoc
4463

I'd use a reserved example domain here instead. Maybe john-doe@example.org.

4465

As above, for the URL domain.

documentation/content/en/books/porters-handbook/special/_index.adoc
4463

That was copied from the Lua example, which in turn I think I copied from the Python example; those should probably be fixed too.

This revision is now accepted and ready to land.Aug 1 2023, 8:14 PM

Np, we can change the URLs in another review.

Great work! It sounds good from the ports point of view.

I made some comments .

Thanks!

documentation/content/en/books/porters-handbook/special/_index.adoc
4252

Very long sentence. Can we split it?

In most cases, applications should detect the correct version from the configuration variables provided and use pkg-config to determine the name and associated paths.
However, some applications (especially those using their own configuration rules for cmake or meson) will try and always use the latest available version.
In this case either patch the port or declare a build conflict (see below) to ensure that the correct dependency is generated when building outside of poudriere.

4300

Simplify this sentence?

It should not normally be necessary for the port to add any additional dependencies. --> Normally the port should not need any additional dependencies.

4319

If the port cannot be convinced to select a specified Guile version... --> If the port cannot work with a specific Guile version...

4337

porters should be careful, not ports :-) How about:

Such ports must be careful to install Scheme files to... --> Such ports must install Scheme files to...

4402

Probably drop the 'for'?

As for GUILE_CMD and GUILE_CMDPATH, for other tool binaries. --> As GUILE_CMD and GUILE_CMDPATH, for other tool binaries.

or even

Like GUILE_CMD and GUILE_CMDPATH, but for other tool binaries.

4438

I would rephrase this, but I might be wrong:

Where ports using flavors should place a documentation subdirectory --> Documenation subdirectory location for ports using flavors

Same below and in a table above.

documentation/content/en/books/porters-handbook/special/_index.adoc
4319

That changes the meaning; I'll try and find another way to reword it.

Reword some long or confusing sentences largely following fernape's suggestions.

Apply a more consistent style to table entries.

This revision now requires review to proceed.Aug 2 2023, 5:51 PM

For some reason I'm not in the ports committers group, but you can consider this approved.

Thanks for the work!

This revision is now accepted and ready to land.Aug 3 2023, 6:44 AM

I'm gonna make the commit