From 1ab0dee51865dc67146be842914ab2bc883111a9 Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Fri, 16 Dec 2016 23:26:21 +0000 Subject: various documentation updates Use HTTPS URLs when possible, add links to NNTP archives, and note we're a deprecated project. --- .olddoc.yml | 9 ++++++--- HACKING | 4 ++-- ISSUES | 10 ++++------ README | 15 +++++++-------- 4 files changed, 19 insertions(+), 19 deletions(-) diff --git a/.olddoc.yml b/.olddoc.yml index 83f2398..7ca79cd 100644 --- a/.olddoc.yml +++ b/.olddoc.yml @@ -1,10 +1,13 @@ --- -cgit_url: http://bogomips.org/kgio.git +cgit_url: https://bogomips.org/kgio.git git_url: git://bogomips.org/kgio.git -ml_url: http://bogomips.org/kgio-public/ -rdoc_url: http://bogomips.org/kgio/ +ml_url: https://bogomips.org/kgio-public/ +rdoc_url: https://bogomips.org/kgio/ public_email: kgio-public@bogomips.org private_email: kgio@bogomips.org noindex: - LATEST - TODO +nntp_url: + - nntp://news.public-inbox.org/inbox.comp.lang.ruby.kgio + - nntp://news.gmane.org/gmane.comp.lang.ruby.kgio.general diff --git a/HACKING b/HACKING index 9155bbc..7556f42 100644 --- a/HACKING +++ b/HACKING @@ -2,14 +2,14 @@ === Documentation -We use the latest version of {olddoc}[http://80x24.org/olddoc/] as +We use the latest version of {olddoc}[https://80x24.org/olddoc/] as much as possible. Please wrap documentation at 72 characters-per-line or less (long URLs are exempt) so it is comfortably readable from terminals. When referencing mailing list posts, use -"http://bogomips.org/kgio-public/$MESSAGE_ID/" if possible since the +"https://bogomips.org/kgio-public//" if possible since the Message-ID remains searchable even if the archive becomes unavailable. === Code Compatibility diff --git a/ISSUES b/ISSUES index 99e61ef..75de28c 100644 --- a/ISSUES +++ b/ISSUES @@ -2,8 +2,8 @@ The kgio {mailing list}[mailto:kgio-public@bogomips.org] is the best place to report bugs, submit patches and/or obtain support after you -have searched the mailing list archives at http://bogomips.org/kgio-public/ -and {documentation}[http://bogomips.org/kgio]. +have searched the mailing list archives at https://bogomips.org/kgio-public/ +and {documentation}[https://bogomips.org/kgio/]. * Do not {top post}[http://catb.org/jargon/html/T/top-post.html] in replies * Quote only the relevant portions of the message you're replying to @@ -30,7 +30,5 @@ guidelines for patch submission. == Mailing List Archives -* http://bogomips.org/kgio-public/ -* git://bogomips.org/kgio-public/ - (see http://ssoma.public-inbox.org/ for layout) -* NNTP coming soon +* https://bogomips.org/kgio-public/ +* nntp://news.public-inbox.org/inbox.comp.lang.ruby.kgio diff --git a/README b/README index 9465fbd..19c1251 100644 --- a/README +++ b/README @@ -1,9 +1,9 @@ = kgio - kinder, gentler I/O for Ruby -kgio provides non-blocking I/O methods for Ruby without raising -exceptions on EAGAIN and EINPROGRESS. It is intended for use with the -unicorn Rack server, but may be used by other applications (that run on -Unix-like platforms). +This is a legacy project, do not use it for new projects. Ruby +2.3 and later should make this obsolete. kgio provides +non-blocking I/O methods for Ruby without raising exceptions on +EAGAIN and EINPROGRESS. == Features @@ -21,9 +21,8 @@ Unix-like platforms). callbacks (such as adding the file descriptor to a poll set and yielding the current Fiber). -* Uses - {accept4}[http://kernel.org/doc/man-pages/online/pages/man2/accept4.2.html] - on new GNU/Linux systems to avoid unnecessary fcntl() calls +* Uses {accept4}[http://man7.org/linux/man-pages/man2/accept4.2.html] + on newer GNU/Linux systems to avoid unnecessary fcntl() calls * Uses MSG_DONTWAIT on GNU/Linux to further avoid unnecessary fcntl() calls @@ -46,7 +45,7 @@ You can get the latest source via git from the following locations You may browse the code from the web and download the latest snapshot tarballs here: -* http://bogomips.org/kgio.git (cgit) +* https://bogomips.org/kgio.git * http://repo.or.cz/w/kgio.git (gitweb) See the HACKING guide on how to contribute and build prerelease gems -- cgit v1.2.3-24-ge0c7