Page MenuHomeFreeBSD

articles: Add language server in the FreeBSD src tree guide
ClosedPublic

Authored by khng on Jun 11 2021, 6:02 PM.
Tags
None
Referenced Files
Unknown Object (File)
Feb 7 2024, 12:59 AM
Unknown Object (File)
Jan 14 2024, 10:51 PM
Unknown Object (File)
Dec 20 2023, 8:17 AM
Unknown Object (File)
Nov 15 2023, 3:07 PM
Unknown Object (File)
Nov 10 2023, 10:01 PM
Unknown Object (File)
Nov 9 2023, 3:48 AM
Unknown Object (File)
Nov 8 2023, 7:50 PM
Unknown Object (File)
Nov 8 2023, 7:07 AM

Details

Summary

This guide is to introduce the use of language server daemon in the
FreeBSD src tree.

Sponsored by: The FreeBSD Foundation

Diff Detail

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

Event Timeline

khng requested review of this revision.Jun 11 2021, 6:02 PM
khng created this revision.

Wording changes and toc fixes

ceri added inline comments.
documentation/content/en/articles/freebsd-src-lsp/_index.adoc
83

Is “whitelist” a baked in term or can we use “allowlist” instead?
(not asking about merit here, just whether there is code outside the scope of this doc that requires this to say “whitelist”).

237

“if it is present”

khng marked 2 inline comments as done.

Wording changes.

Cool, I like this addition of language servers. I added some language improvements.

documentation/content/en/articles/freebsd-src-lsp/_index.adoc
34

The use of you is discouraged in technical documentation.

75

s/if you are using/when using/g

142

s/if you run/when running/g

207

Another use of "you" here.

237

Line break needed here before "Entries" (one sentence per line).

243

s/Once compilation/Once the compilation/
s/you can open/open/ (active voice, avoid use of you)

244

s/give complete result/give a complete result/

245

s/in compilation/in the compilation/
s/thus you would not see complete/thus no complete results are shown/

pauamma_gundo.com added inline comments.
documentation/content/en/articles/freebsd-src-lsp/_index.adoc
3

Missing "the"/"a" here?

8

Ditto

13

And again.

146
177
208

Missing comma before "merged"?

209

It generally looks good to me, and it is a really nice read! Added some minor nits. Thanks for doing this.

documentation/content/en/articles/freebsd-src-lsp/_index.adoc
56
102
140
214
230
khng marked 14 inline comments as done.

Updated.

documentation/content/en/articles/freebsd-src-lsp/_index.adoc
177

I reworded the whole part to match the exact behavior.

khng marked 2 inline comments as done.Jun 13 2021, 5:51 PM
khng added inline comments.
documentation/content/en/articles/freebsd-src-lsp/_index.adoc
3

This should be capitalized instead in my opinion because I meant a technology here.

8

same as above.

13

same as above.

208

I don't get this.

209

I don't get this either.

khng marked an inline comment as done.

Updated title

documentation/content/en/articles/freebsd-src-lsp/_index.adoc
208

The line this was meant to apply to probably moved due to other changes, and I can't find it anymore. Ignore at will.

209

Same.

documentation/content/en/articles/freebsd-src-lsp/_index.adoc
3

This looks a bit weird to my eye as well - maybe adding an "a"?

35
106
147
242
249
khng marked 5 inline comments as done.

ygy@ fixes

khng marked an inline comment as done.Jun 21 2021, 7:53 AM

Thanks for making all the changes! This looks good to my eye, and I am happy to see it in the tree.

title: Deploying a Language Server in the FreeBSD src tree

One last comment is that, after another look, the title has some ambiguity to me. I think it could be something like:

title: Use Language Servers for Development in the FreeBSD src tree

What do you think? @khng @ceri @bcr

This revision is now accepted and ready to land.Jun 21 2021, 8:02 AM

Better title given by ygy@

This revision now requires review to proceed.Jun 21 2021, 8:05 AM

I'd wait for other reviewers on this thread to see if they have additional comments, but again, this looks good to me. Thanks! :)

This revision is now accepted and ready to land.Jun 21 2021, 8:20 AM
This revision now requires review to proceed.Jun 26 2021, 8:31 AM
This revision is now accepted and ready to land.Jun 26 2021, 8:32 AM