Page MenuHomeFreeBSD
Differential D2781

Add a bit of documentation about the new multiple-USE_GITHUB.
ClosedPublic
Actions

Authored by mat on Jun 11 2015, 2:32 PM.
Tags
None
Referenced Files
Unknown Object (File)
Fri, Apr 18, 5:47 AM
Unknown Object (File)
Sun, Apr 6, 8:07 AM
Unknown Object (File)
Fri, Mar 28, 2:47 PM
Unknown Object (File)
Mar 3 2025, 8:50 PM
Unknown Object (File)
Feb 28 2025, 9:07 AM
Unknown Object (File)
Feb 17 2025, 6:56 AM
Unknown Object (File)
Jan 11 2025, 9:55 PM
Unknown Object (File)
Jan 7 2025, 5:28 PM
View All Files
Subscribers
pgollucci

Details

Reviewers
gjb
wblock
Commits
rD46900: Document the new multiple-USE_GITHUB.

Diff Detail

Repository
rD FreeBSD doc repository - subversion
Lint
No Lint Coverage
Unit
No Test Coverage

Event Timeline

mat updated this revision to Diff 6105.Jun 11 2015, 2:32 PM
mat retitled this revision from to Add a bit of documentation about the new multiple-USE_GITHUB..
mat updated this object.
mat edited the test plan for this revision. (Show Details)
mat added reviewers: wblock, gjb.
mat updated this revision to Diff 6117.Jun 11 2015, 8:13 PM

Create a sub-section inside USE_GITHUB to keep the multi-files thing to themselves.

mat updated this revision to Diff 6120.Jun 11 2015, 8:26 PM

Shorten a title.

mat updated this revision to Diff 6122.Jun 12 2015, 12:28 AM
  • Extract USE_GITHUB from MASTER_SITES.
wblock added inline comments.Jun 26 2015, 11:31 AM
en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
1926

s/The/the/

1927

s/would end/ends/

1974

"similar to" is the more common way to say that.

It works in a way very similar to <xref

1980

Split the sentence:
<varname>GH_TAGNAME</varname>. Each different value is

1989

s/it contains/containing/

2022

Split up the sentence:
github. The default file comes from

2024

<literal>1.0.2</literal>. The second file, tagged

2027

<literal>1.0</literal>. The third file comes from

2035

An "are" is missing in this sentence, either "are extracted" here, or "are in their respective" in the next line.

2037

s/sub-directories/subdirectories/
"default one" is kind of vague, usually better to be specific, the "default file" or whatever.

2040

additional distribution file is extracted in its

2041

End sentence at the end of the line:
<varname>${WRKSRC_<replaceable>tag</replaceable>}</varname>.

2042

Here, the <literal>icons</literal> tag is called

2044

Split sentence:
<filename>${WRKDIR}/foo-icons-1.0</filename>. The file

mat marked 14 inline comments as done.Jun 29 2015, 11:39 AM
mat updated this revision to Diff 6540.Jun 29 2015, 11:40 AM

With @wblock's comments.

mat set the repository for this revision to rD FreeBSD doc repository - subversion.Jun 29 2015, 11:41 AM
wblock accepted this revision.Jun 29 2015, 10:07 PM
wblock edited edge metadata.

Looks good to me. #include $igor-build-note. :)

This revision is now accepted and ready to land.Jun 29 2015, 10:07 PM
pgollucci added a subscriber: pgollucci.Jun 30 2015, 1:03 AM

this makes sense to me.

Closed by commit rD46900: Document the new multiple-USE_GITHUB. (authored by mat). · Explain WhyJun 30 2015, 11:10 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathSize
en_US.ISO8859-1/
books/
porters-handbook/
makefiles/
82 lines

Diff 6117

View Options

en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml

  • This file was added.
.\" Copyright (c) 2018 Emmanuel Vadot <manu@freebsd.org>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd November 12, 2018
.Dt PWMBUS 9
.Os
.Sh NAME
.Nm pwmbus ,
.Nm pwmbus_attach_bus ,
.Nm PWMBUS_GET_BUS ,
.Nm PWMBUS_CHANNEL_CONFIG ,
.Nm PWMBUS_CHANNEL_GET_CONFIG ,
.Nm PWMBUS_CHANNEL_SET_FLAGS ,
.Nm PWMBUS_CHANNEL_GET_FLAGS ,
.Nm PWMBUS_CHANNEL_ENABLE ,
.Nm PWMBUS_CHANNEL_IS_ENABLED ,
.Nm PWMBUS_CHANNEL_MAX
.Nd PWMBUS methods
.Sh SYNOPSIS
.Cd "device pwm"
.In "pwmbus_if.h"
.Ft device_t
.Fn pwmbus_attach_bus "device_t dev"
.Ft int
.Fn PWMBUS_CHANNEL_CONFIG "device_t bus" "int channel" "uint64_t period" "uint64_t duty"
.Ft int
.Fn PWMBUS_CHANNEL_GET_CONFIG "device_t bus" "int channel" "uint64_t *period" "uint64_t *duty"
.Ft int
.Fn PWMBUS_CHANNEL_SET_FLAGS "device_t bus" "int channel" "uint32_t flags"
.Ft int
.Fn PWMBUS_CHANNEL_GET_FLAGS "device_t bus" "int channel" "uint32_t *flags"
.Ft int
.Fn PWMBUS_CHANNEL_ENABLE "device_t bus" "int channel" "bool enable"
.Ft int
.Fn PWMBUS_CHANNEL_IS_ENABLED "device_t bus" "int channel" "bool *enabled"
.Ft int
.Fn PWMBUS_CHANNEL_MAX "device_t bus" "int channel" "int *nchannel"
.Sh DESCRIPTION
The PWMBUS (Pulse-Width Modulation) interface allows the device driver to register to a global
0mpUnsubmitted
Done
Inline Actions

This paragraph has similar issues to the one from the other manual page reviewed by @bcr.

0mp: This paragraph has similar issues to the one from the other manual page reviewed by @bcr.
bcrUnsubmitted
Done
Inline Actions

This is still the old version? Should be fixing the same issue as above (s/allow device/allows the device/)

bcr: This is still the old version? Should be fixing the same issue as above (s/allow device/allows…
bus so other devices in the kernel can use them in a generic way
.Sh INTERFACE
.Bl -tag -width indent
.It Fn pwmbus_attach_bus "device_t dev"
Attach the pwmbus to the device driver
0mpUnsubmitted
Done
Inline Actions

.Nm pwmbus

0mp: .Nm pwmbus
.It Fn PWMBUS_CHANNEL_CONFIG "device_t bus" "int channel" "uint64_t period" "uint64_t duty"
Configure the period and duty (in nanoseconds) in the pwm controller on the bus for the specified channel.
0mpUnsubmitted
Done
Inline Actions

s/pwm/PWM/

0mp: s/pwm/PWM/
Returns 0 on success or EINVAL is the values are not supported by the controller or
0mpUnsubmitted
Done
Inline Actions

.Er EINVAL

0mp: .Er EINVAL
EBUSY is the PWMBUS controller is in use and doesn't support changing the value on the fly.
.It Fn PWMBUS_CHANNEL_GET_CONFIG "device_t bus" "int channel" "uint64_t *period" "uint64_t *duty"
Get the current configuration of the period and duty for the specified channel.
.It Fn PWMBUS_CHANNEL_SET_FLAGS "device_t bus" "int channel" "uint32_t flags"
Set the flags of the channel (like inverted polarity), if the driver or controller
doesn't support this a default method is used.
.It Fn PWMBUS_CHANNEL_GET_FLAGS "device_t bus" "int channel" "uint32_t *flags"
Get the current flags for the channel, if the driver or controller
doesn't support this, a default method is used.
.It Fn PWMBUS_CHANNEL_ENABLE "device_t bus" "int channel" "bool enable"
Enable the pwm channel.
0mpUnsubmitted
Done
Inline Actions

s/pwm/PWM

0mp: s/pwm/PWM
.It Fn PWMBUS_CHANNEL_ISENABLED "device_t bus" "int channel" "bool *enable"
Test if the pwm channel is enabled.
0mpUnsubmitted
Done
Inline Actions

s/pwm/PWM

0mp: s/pwm/PWM
.It PWMBUS_CHANNEL_MAX "device_t bus" "int channel" "int *nchannel"
Get the maximum number of channel supported by the controller.
.El
.Sh HISTORY
The pwmbus interface first appear in
0mpUnsubmitted
Done
Inline Actions

.Nm pwmbus

0mp: .Nm pwmbus
.Fx 13.0 .
The pwmbus interface and manual page was written by
0mpUnsubmitted
Done
Inline Actions

.Nm pwmbus

0mp: .Nm pwmbus
.An Emmanuel Vadot Aq Mt manu@FreeBSD.org .