Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(unsure) development.7: add files #1274

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions share/man/man7/development.7
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.\"-
.\" SPDX-License-Identifier: BSD-2-Clause
.\"
.\" Copyright (c) 2018 Edward Tomasz Napierala <[email protected]>
.\"
.\" Redistribution and use in source and binary forms, with or without
Expand Down Expand Up @@ -89,7 +92,7 @@
.Xr release 7 .
Kernel programming interfaces (KPIs) are documented in section 9
manual pages; use
.Ql "apropos -s 9 ."
.Ql apropos -s 9 \&.
for a list.
Regression test suite is described in
.Xr tests 7 .
Expand All @@ -116,10 +119,17 @@
the continuous integration system is at:
.Pp
.Lk https://ci.FreeBSD.org
.Pp
.Sh FILES
.Bl -tag -width "src/tools/tools/git/HOWTO" -compact
.It Pa src/CONTRIBUTING.md
.Fx
contribution guidelines
.It Pa src/tools/tools/git/HOWTO
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMO we should not link to this, it is stale. If desired we could extract useful content into somewhere less hidden.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rationale: doc and ports trees don't accept gihub PRs. I had patches sitting in there for months, but then when I discovered how to put them on phabricator, the discussions began immediately. Then from there, git-arc(1) took me even longer to discover and is actually cozy.

I'm open to any suggestions how to solve this problem in a better way, but that was the problem I'm trying to solve.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, but the arcgit tool described in the HOWTO is something older and separate from git-arc, but with similar functionality. It is a step backwards to start advertising it now.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea. I'd delete that file even i think and put everything in contributing.md

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks so much for your time!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Id keep contributing. Sorry if that wasn't clear. Just the howto file that's a problem

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to mention git-arc. Is it more appropriate:

  1. Files: git-arc.sh
  2. Files: git-arc.1
  3. See also: /path/git-arc.1

Introduction to review submission tooling
.El
.Sh EXAMPLES
Check out the CURRENT branch, build it, and install, overwriting the current
system:

Check warning on line 132 in share/man/man7/development.7

View workflow job for this annotation

GitHub Actions / Style Checker

Missing Signed-off-by: line
.Bd -literal -offset indent
git clone https://git.FreeBSD.org/src.git src
cd src
Expand Down Expand Up @@ -182,13 +192,12 @@
.Xr tests 7 ,
.Xr locking 9 ,
.Xr style 9
.Sh HISTORY

Check warning on line 195 in share/man/man7/development.7

View workflow job for this annotation

GitHub Actions / Style Checker

Missing Signed-off-by: line
The
.Nm
manual page was originally written by
.An Matthew Dillon Aq Mt [email protected]
and first appeared
in
and first appeared in
.Fx 5.0 ,
December 2002.
It was since extensively modified by
Expand Down
Loading