From 63841571433d9df1a70b84eec3a784aa7c43f23f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?LAURENS=20J=C3=A9r=C3=B4me?= Date: Mon, 3 Jun 2024 03:01:44 +0200 Subject: [PATCH] Revert "Documentation: fix lfs, stevedonovan and orbit broken links" This reverts commit e61f4df82882f457ac21e58c190dafcaee5a1d8d. --- docs/libraries/pl.path.html | 16 ++++++++-------- docs/manual/01-introduction.md.html | 3 ++- docs/manual/04-paths.md.html | 2 +- docs/manual/06-data.md.html | 2 +- docs_topics/01-introduction.md | 2 +- docs_topics/06-data.md | 2 +- lua/pl/path.lua | 14 +++++++------- 7 files changed, 21 insertions(+), 20 deletions(-) diff --git a/docs/libraries/pl.path.html b/docs/libraries/pl.path.html index 81a0fca6..9c366cc7 100644 --- a/docs/libraries/pl.path.html +++ b/docs/libraries/pl.path.html @@ -128,7 +128,7 @@

Module pl.path

is Windows paths to allow both forward and backward slashes (since Lua also accepts those)

-

Dependencies: pl.utils, lfs

+

Dependencies: pl.utils, lfs

Functions

@@ -279,7 +279,7 @@

Functions

Lua iterator over the entries of a given directory. - Implicit link to luafilesystem.dir + Implicit link to luafilesystem.dir @@ -294,7 +294,7 @@

Functions

Creates a directory. - Implicit link to luafilesystem.mkdir + Implicit link to luafilesystem.mkdir @@ -309,7 +309,7 @@

Functions

Removes a directory. - Implicit link to luafilesystem.rmdir + Implicit link to luafilesystem.rmdir @@ -324,7 +324,7 @@

Functions

Gets attributes. - Implicit link to luafilesystem.attributes + Implicit link to luafilesystem.attributes @@ -339,7 +339,7 @@

Functions

Get the working directory. - Implicit link to luafilesystem.currentdir + Implicit link to luafilesystem.currentdir @@ -354,7 +354,7 @@

Functions

Gets symlink attributes. - Implicit link to luafilesystem.symlinkattributes + Implicit link to luafilesystem.symlinkattributes @@ -371,7 +371,7 @@

Functions

Changes the working directory. On Windows, if a drive is specified, it also changes the current drive. If only specifying the drive, it will only switch drive, but not modify the path. - Implicit link to luafilesystem.chdir + Implicit link to luafilesystem.chdir diff --git a/docs/manual/01-introduction.md.html b/docs/manual/01-introduction.md.html index d07f27c9..f8759281 100644 --- a/docs/manual/01-introduction.md.html +++ b/docs/manual/01-introduction.md.html @@ -168,7 +168,8 @@

Purpose

perverse, this matches the intended use better.

The only important external dependence of Penlight is -LuaFileSystem, and if you want dir.copyfile to work cleanly on Windows, you will need +LuaFileSystem +(lfs), and if you want dir.copyfile to work cleanly on Windows, you will need either alien or be using LuaJIT as well. (The fallback is to call the equivalent shell commands.)

diff --git a/docs/manual/04-paths.md.html b/docs/manual/04-paths.md.html index cb29cbcd..03295a9d 100644 --- a/docs/manual/04-paths.md.html +++ b/docs/manual/04-paths.md.html @@ -240,7 +240,7 @@

Directory Operations

functions in the Python fnmatch module. getdirectories will return all directories contained in a directory, and getfiles will return all files in a directory which match a shell pattern. These functions return the files as a -table, unlike lfs.dir which returns an iterator.)

+table, unlike lfs.dir which returns an iterator.)

dir.makepath can create a full path, creating subdirectories as necessary; rmtree is the Nuclear Option of file deleting functions, since it will diff --git a/docs/manual/06-data.md.html b/docs/manual/06-data.md.html index 88b2a81b..62c775f4 100644 --- a/docs/manual/06-data.md.html +++ b/docs/manual/06-data.md.html @@ -1264,7 +1264,7 @@

Parsing and Working with Configuration Files

Generating XML with 'xmlification'

This feature is inspired by the htmlify function used by -Orbit to simplify HTML generation, +Orbit to simplify HTML generation, except that no function environment magic is used; the tags function returns a set of constructors for elements of the given tag names.

diff --git a/docs_topics/01-introduction.md b/docs_topics/01-introduction.md index 8aba2c84..102caa9f 100644 --- a/docs_topics/01-introduction.md +++ b/docs_topics/01-introduction.md @@ -41,7 +41,7 @@ the order, so that the function is passed the value and then the key. Although perverse, this matches the intended use better. The only important external dependence of Penlight is -[LuaFileSystem](http://lunarmodules.github.com/luafilesystem/manual.html) +[LuaFileSystem](http://keplerproject.github.com/luafilesystem/manual.html) (`lfs`), and if you want `dir.copyfile` to work cleanly on Windows, you will need either [alien](http://alien.luaforge.net/) or be using [LuaJIT](http://luajit.org) as well. (The fallback is to call the equivalent diff --git a/docs_topics/06-data.md b/docs_topics/06-data.md index b95d6dbe..3ca8a3a5 100644 --- a/docs_topics/06-data.md +++ b/docs_topics/06-data.md @@ -960,7 +960,7 @@ Getting the names of the providers per-country is straightforward: #### Generating XML with 'xmlification' This feature is inspired by the `htmlify` function used by -[Orbit](http://keplerproject.github.io/orbit/) to simplify HTML generation, +[Orbit](http://keplerproject.github.com/orbit/) to simplify HTML generation, except that no function environment magic is used; the `tags` function returns a set of _constructors_ for elements of the given tag names. diff --git a/lua/pl/path.lua b/lua/pl/path.lua index 89df095f..600bf057 100644 --- a/lua/pl/path.lua +++ b/lua/pl/path.lua @@ -45,12 +45,12 @@ local function err_func(name, param, err, code) end --- Lua iterator over the entries of a given directory. --- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#dir) +-- Implicit link to [`luafilesystem.dir`](https://keplerproject.github.io/luafilesystem/manual.html#reference) -- @function dir path.dir = lfs.dir --- Creates a directory. --- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#mkdir) +-- Implicit link to [`luafilesystem.mkdir`](https://keplerproject.github.io/luafilesystem/manual.html#reference) -- @function mkdir path.mkdir = function(d) local ok, err, code = lfs.mkdir(d) @@ -61,7 +61,7 @@ path.mkdir = function(d) end --- Removes a directory. --- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#rmdir) +-- Implicit link to [`luafilesystem.rmdir`](https://keplerproject.github.io/luafilesystem/manual.html#reference) -- @function rmdir path.rmdir = function(d) local ok, err, code = lfs.rmdir(d) @@ -72,7 +72,7 @@ path.rmdir = function(d) end --- Gets attributes. --- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#attributes) +-- Implicit link to [`luafilesystem.attributes`](https://keplerproject.github.io/luafilesystem/manual.html#reference) -- @function attrib path.attrib = function(d, r) local ok, err, code = attrib(d, r) @@ -83,7 +83,7 @@ path.attrib = function(d, r) end --- Get the working directory. --- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#currentdir) +-- Implicit link to [`luafilesystem.currentdir`](https://keplerproject.github.io/luafilesystem/manual.html#reference) -- @function currentdir path.currentdir = function() local ok, err, code = currentdir() @@ -94,7 +94,7 @@ path.currentdir = function() end --- Gets symlink attributes. --- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#symlinkattributes) +-- Implicit link to [`luafilesystem.symlinkattributes`](https://keplerproject.github.io/luafilesystem/manual.html#reference) -- @function link_attrib path.link_attrib = function(d, r) local ok, err, code = link_attrib(d, r) @@ -107,7 +107,7 @@ end --- Changes the working directory. -- On Windows, if a drive is specified, it also changes the current drive. If -- only specifying the drive, it will only switch drive, but not modify the path. --- Implicit link to [`luafilesystem.dir`](https://lunarmodules.github.io/luafilesystem/manual.html#chdir) +-- Implicit link to [`luafilesystem.chdir`](https://keplerproject.github.io/luafilesystem/manual.html#reference) -- @function chdir path.chdir = function(d) local ok, err, code = lfs.chdir(d)