Bug 264921

Summary:

Update vim configuration

Product:

Documentation

Reporter:

Muhammad Moinur Rahman <bofh>

Component:

Books & Articles

Assignee:

Muhammad Moinur Rahman <bofh>

Status:

Closed FIXED

Severity:

Affects Only Me

CC:

carlavilla

Priority:

---

Version:

Latest

Hardware:

Any

OS:

Any

Attachments:

Description	Flags
Update vim configuration	none

Description Muhammad Moinur Rahman freebsd_committer

2022-06-27 03:47:21 UTC

Created attachment 234964 [details]
Update vim configuration

In the https://docs.freebsd.org/en/books/fdp-primer/book/#editor-config-vim section the vim configuration is outdated and misinformed:

- vim-tiny do not come with syntax highlighting files so recommending that might be counter-productive
- For advanced users advise ale linter(I only have confusion about this; so suggest please)
- Split the functions for two different purposes: adoc and man
- There is no concept of wrapping in adoc as we are following the rule "one sentence one line". On the other hand man pages should have a wrap at around 72 considering the historical purpose. So remove wrapping(Press[P]) from adoc and use only for man
- There is also no usage of TAB too in adoc so accompany the(Press[T]) only for man and remove from adoc
- Extra White Spaces should be applicable for both adoc and man while Over Length marker should be only for man
- Use appropriate syntax and filetype for asciidoc and man

Comment 1 Chris Rees freebsd_committer

2022-06-27 12:57:59 UTC

Excellent, please go ahead.

Comment 2 commit-hook freebsd_committer

2022-06-28 07:44:43 UTC

A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=cab164f9878a93df4fb10f49939a991c46fb283e

commit cab164f9878a93df4fb10f49939a991c46fb283e
Author:     Muhammad Moinur Rahman <bofh@FreeBSD.org>
AuthorDate: 2022-06-28 07:40:09 +0000
Commit:     Muhammad Moinur Rahman <bofh@FreeBSD.org>
CommitDate: 2022-06-28 07:40:09 +0000

    Update vim config for adoc files

    In the en/books/fdp-primer/book/#editor-config-vim section the vim
    configuration is outdated and misinformed:

    - vim-tiny do not come with syntax highlighting files so recommending
      that might be counter-productive
    - For advanced users advise ale linter
    - Split the functions for two different purposes: adoc and man
    - There is no concept of wrapping in adoc as we are following the rule
      "one sentence one line". On the other hand man pages should have a
      wrap at around 72 considering the historical purpose. So remove
      wrapping(Press[P]) from adoc and use only for man
    - There is also no usage of TAB too in adoc so accompany the(Press[T])
      only for man and remove from adoc
    - Extra White Spaces should be applicable for both adoc and man while
      OverLength marker should be only for man
    - Use appropriate syntax and filetype for asciidoc and man

    PR:             264921
    Approved by:    crees

 .../en/books/fdp-primer/editor-config/_index.adoc  | 84 +++++++++++++---------
 1 file changed, 51 insertions(+), 33 deletions(-)

Comment 3 Muhammad Moinur Rahman freebsd_committer

2022-06-28 07:44:58 UTC

Thanks.