Commit Graph

18 Commits

Author SHA1 Message Date
Warner Losh
c6755605f6 Per Ravi Pokala's suggestion, rewrite the g_reset_bio description to
be clearer. It also describes it with more nuance. Add missing MLINKS
noticed by trasz@. Bump the date.
2016-05-17 17:08:13 +00:00
Warner Losh
1f1bf434c6 Bump date. Forgotten in r299312. 2016-05-10 04:01:04 +00:00
Warner Losh
7043b9898f Document g_reset_bio(). This is long overdue. g_reset_bio will reset
the bio to a pristine state should you wish to re-use it for another
I/O without freeing it. In the bast, a simple bzero was done to do
this, but that may not be sufficient in the future when the bio may
contain state that's not part of the documented API. Besides, it makes
the code clearer as to the intent...

Noticed by: smh@
2016-05-10 03:57:47 +00:00
Christian Brueffer
645babfa8f Fix a comment typo in the code example.
PR:		203497
Submitted by:	chadf@triularity.org
MFC after:	1 week
2015-12-07 19:21:08 +00:00
Baptiste Daroussin
8a7314fcb5 use .Mt to mark up email addresses consistently (part6)
PR:		191174
Submitted by:	Franco Fichtner <franco at lastsummer.de>
2014-06-26 21:44:30 +00:00
Wojciech A. Koszek
fe2e562728 Add missing 'bp', since it should be passed as g_print_bio() argument.
Oked by:	pjd
2007-05-06 12:48:39 +00:00
Pawel Jakub Dawidek
89780ffb72 Better English.
Submitted by:	ru
2006-11-01 12:44:28 +00:00
Pawel Jakub Dawidek
2c0ea12df5 - Document two new function g_alloc_bio() and g_duplicate_bio().
- Bump modification date.
- Update copyright years.
2006-11-01 12:42:14 +00:00
Pawel Jakub Dawidek
c4639cb3d8 Document BIO_FLUSH request. 2006-11-01 12:34:35 +00:00
Pawel Jakub Dawidek
51385a3c00 - Add two fields to bio structure: 'bio_cflags' which can be used by
consumer and 'bio_pflags' which can be used by provider.
- Remove BIO_FLAG1 and BIO_FLAG2 flags. From now on new fields should be
  used for internal flags.
- Update g_bio(9) manual page.
- Update some comments.
- Update GEOM_MIRROR, which was the only one using BIO_FLAGs.

Idea from:	phk
Reviewed by:	phk
2004-08-04 21:35:05 +00:00
Ruslan Ermilov
6f39ea8888 Tiny markup fixes. 2004-07-06 08:21:12 +00:00
Ruslan Ermilov
1c85060a13 Sort SEE ALSO references (in dictionary order, ignoring case). 2004-07-04 20:55:50 +00:00
Mike Pritchard
2988974b58 Spelling fixes. 2004-06-21 14:11:45 +00:00
Lukas Ertl
a2d7d4d7c6 These hyphens don't need to be escaped.
Pointed out by:  pjd@
2004-05-18 12:36:12 +00:00
Lukas Ertl
eaad868d16 Update several GEOM related manual pages:
*) Fix spelling errors.
  *) Better english.
  *) Re-phrasing.

Not Reviewed by:  pjd (one week timeout)
Approved by:      grog (mentor)
2004-05-18 11:33:37 +00:00
Pawel Jakub Dawidek
8217df6de8 Add reference to the g_access(9) manual page. 2004-03-11 19:53:22 +00:00
Pawel Jakub Dawidek
462b8db96b Document g_print_bio() function.
Approved by:	scottl (mentor)
2004-02-11 18:36:31 +00:00
Pawel Jakub Dawidek
f827ccb9a3 Added first part of GEOM kernel API manuals pages.
Documented function and macros are:
	- DECLARE_GEOM_CLASS(),
	- g_attach(),
	- g_detach(),
	- g_new_bio(),
	- g_clone_bio(),
	- g_destroy_bio(),
	- g_new_consumer(),
	- g_destroy_consumer(),
	- g_read_data(),
	- g_write_data(),
	- g_post_event(),
	- g_waitfor_event(),
	- g_cancel_event(),
	- g_new_geomf(),
	- g_destroy_geom(),
	- g_new_providerf(),
	- g_destroy_provider(),
	- g_error_provider(),
	- g_provider_by_name(),
	- g_wither_geom().
and more to come.

I want to thanks following people for help with those documents:
	Slawek Zak <zaks@prioris.mini.pw.edu.pl>
	Simon L. Nielsen <simon@FreeBSD.org>
	Pieter de Boer <g.p.de.boer@st.hanze.nl>
and of course
	Poul-Henning Kamp <phk@FreeBSD.org>

Reviewed by:	phk, scottl
Approved by:	phk, scottl (mentor)
2004-02-11 10:06:18 +00:00