From nobody Mon Mar 27 21:08:01 2023 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4PlllP65rWz424R7 for ; Mon, 27 Mar 2023 21:08:01 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4PlllP56Kvz3j4X; Mon, 27 Mar 2023 21:08:01 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1679951281; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=pdpPhZCpmm1iNRvGLzwwHuJCkkDTxsZ94Ob39xC3maw=; b=OXSDtqeDwiIutlKRj8Cd7b1ihIO+XLrzhOFuKRHoUla4w2vt/ixFsx7QIwa5C7dhUTrm5D MqcleR9MMnD5ILW/iS4w05wFbRW3MzW7/c64MI3CznqTX/+MHV4piiUZQhNs5e2sHFRh4H cQwudjHFoxkoWx04XhIgPCEGXqBuBqXq49cRRdPhSyb+lJT+EoPbXK3lQevdKX9rMve5iI qQwzmJXfBhHhVs+yFOGCkKQW+BK6z5nA6qojgJUDsUmpR/iS5Jg5ke9oVNF7g7nA41S82u AXPdS1zBanfquQXLwLyaFDEkev6Nin+Y4FGAyl8lyZGC7mQCIpGRo40jdnkkMg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1679951281; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=pdpPhZCpmm1iNRvGLzwwHuJCkkDTxsZ94Ob39xC3maw=; b=GO5Y3ZZ+inj7H2bk0gD1vnnnPHy4Fz/MwsNocbhUPFEoKTNcmXrEFX1B3KzSMX+PL0JvxZ a5EZ82wndPV6WBcfGZnIZFZ1hvfIQW/lIK67d0m8VctRET3vrUNG5PjC+qSpVHxtRQ4aLr U5b22QS5Guuovu9/YfGZ7q01ppTUT3w0MaKp753hvim8MZtziWKVHqA/PGciQsbvtchCDB 287K6dIGroJYK6DhZ2uwQ/GA2c2Axa3QeI6c9XiGisi2UEXblfFz5A3+HCu60/69g8n0Fw mtuiuUDTdBxN2O6v6od3VlNJwJzVP1s11g4OyuiBrtG0n2q2oCDg2YFGvDg/aQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1679951281; a=rsa-sha256; cv=none; b=k39h3j+kPo09py9AalAWieWoMlSz/f/oOR005DXbZyA1c4fszlXUxae+ygHRDe12SqN0wk DnTz3j4YKVvq+lnqbBNnFDbzGAXz/htbgAEfudEJEIsW3dKkd59ZIJ5ALib2sfqz7yv2qM 0SKVcPUivUEjRBGfABDTWD0y/NC09F4/ptzpme4BH8o+/7R4LawlqovDohG3YYDEaP7mAY XHz4knFs0Xpvw48MwfXCr3RxLOv2aztHNwk5FoOMQV0RfDd+TzBKnLSZL7l1erxbGNd5zR KGl/T3rig+UZz7P18M3KoafaPZ3D4FV7qzN3JsJtOXkzOEwlUSkl6rpvO2cmzQ== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4PlllP48grzcS9; Mon, 27 Mar 2023 21:08:01 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 32RL81OK016849; Mon, 27 Mar 2023 21:08:01 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 32RL81HC016848; Mon, 27 Mar 2023 21:08:01 GMT (envelope-from git) Date: Mon, 27 Mar 2023 21:08:01 GMT Message-Id: <202303272108.32RL81HC016848@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Lorenzo Salvadore Subject: git: aaa27bc8bb - main - Status/2023Q1/timerfd.adoc: Improvements List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: salvadore X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: aaa27bc8bb4d13f0997400f137df589ce0794ff5 Auto-Submitted: auto-generated X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by salvadore: URL: https://cgit.FreeBSD.org/doc/commit/?id=aaa27bc8bb4d13f0997400f137df589ce0794ff5 commit aaa27bc8bb4d13f0997400f137df589ce0794ff5 Author: Lorenzo Salvadore AuthorDate: 2023-03-25 10:34:12 +0000 Commit: Lorenzo Salvadore CommitDate: 2023-03-27 21:08:00 +0000 Status/2023Q1/timerfd.adoc: Improvements - Use man:...[] macro. - Use `...` delimiters for code. - Remove line breaks before and after link. Reported by: grahamperrin Reviewed by: grahamperrin Approved by: dbaio (co-mentor), carlavilla (mentor) Differential Revision: https://reviews.freebsd.org/D39265 --- .../content/en/status/report-2023-01-2023-03/timerfd.adoc | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/website/content/en/status/report-2023-01-2023-03/timerfd.adoc b/website/content/en/status/report-2023-01-2023-03/timerfd.adoc index 0b971fc047..9c6841d5de 100644 --- a/website/content/en/status/report-2023-01-2023-03/timerfd.adoc +++ b/website/content/en/status/report-2023-01-2023-03/timerfd.adoc @@ -7,16 +7,14 @@ Contact: Jake Freeland The timerfd facility is a set of Linux-standard system calls that operate on interval timers. These timers are analogous to per-process timers but are represented by a file descriptor, rather than a process. -These file descriptors may be passed to other processes, are preserved across fork(2), and may be monitored via kevent(2), poll(2), or select(2). +These file descriptors may be passed to other processes, are preserved across man:fork[2], and may be monitored via man:kevent[2], man:poll[2], or man:select[2]. -A timerfd implementation in FreeBSD already exists for Linux compatibility, but -link:https://reviews.freebsd.org/D38459[this differential revision] -makes the interface native. +A timerfd implementation in FreeBSD already exists for Linux compatibility, but link:https://reviews.freebsd.org/D38459[this differential revision] makes the interface native. The goal behind this change is to ease the FreeBSD porting process for programs that include timerfd. This specific implementation avoids adding new names to the system call table. -Instead, timerfd_create() is wrapped by the specialfd() system call. -The timerfd_gettime() and timerfd_settime() calls are wrapped ioctl()s. +Instead, `timerfd_create()` is wrapped by the `specialfd()` system call. +The `timerfd_gettime() and `timerfd_settime()` calls are wrapped `ioctl()` s. Developers that wish to support FreeBSD should avoid using timerfd. -The kqueue() EVFILT_TIMER filter is preferred for establishing arbitrary timers. +The `kqueue()` `EVFILT_TIMER` filter is preferred for establishing arbitrary timers.