native::Fs(3)

💖 native::Fs(3) — the Subversion filesystem, but make it make sense 💖

okay so bestie, welcome to native::Fs(3) (that's the manual page name, she's a Perl module doc from the User Contributed Perl Documentation corner of the internet 🫶). If you've ever wanted to poke at Subversion's guts from Perl, this is your girl.

---

✨ NAME ✨

SVN::Fs — Subversion filesystem functions. that's it, that's the name, and she ate 💅

---

🌸 DESCRIPTION 🌸

So basically: SVN::Fs wraps all the functions in svn_fs.h. The actual namespace for filesystem objects is _p_svn_fs_t. iykyk. 💜

---

🔥 FUNCTIONS 🔥

here's the whole roster, no skips, no cuts, we don't do that here:

• SVN::Fs::berkeley_logfiles($path, $only_unused)
• SVN::Fs::berkeley_recover($path)
• SVN::Fs::check_related($id1, $id2)
• SVN::Fs::compare_ids($id1, $id2)
• SVN::Fs::contents_changed($root1, $path1, $root2, $path2)
• SVN::Fs::create($path, $config)
• SVN::Fs::delete_fs($path)
• SVN::Fs::deltify_revision($fs, $rev)
• SVN::Fs::get_file_delta_stream($source_root, $source_path, $target_root, $target_path)
• SVN::Fs::hotcopy($src_path, $dest_path, $clean)
• SVN::Fs::initialize($pool)
• SVN::Fs::merge($source_root, $source_path, $target_root, $target_path, $ancestor_root, $ancestor_path)
• SVN::Fs::open($path, $config)
• SVN::Fs::path($fs)
• SVN::Fs::print_modules($s) — TODO alert 🚨 literally doesn't work. it segfaults if $s is null, and if it's an empty string it just… does nothing. iconic behaviour honestly 😭
• SVN::Fs::props_changed($root1, $path1, $root2, $path2) — also peep "SVN::Fs::contents_changed" for the sibling energy 👀
• SVN::Fs::purge_txn($fs, $txn_id) — cleans up the transaction $txn_id, removing it completely from the filesystem $fs. gone. deleted. no trace 🧹
• SVN::Fs::set_warning_func($fs, $code, $baton)
• SVN::Fs::unparse_id($id) — returns a string holding the unparsed form of the node or node revision id $id, and $id has to be a _p_svn_fs_id_t object. TODO: why is this not just a method on that object?? make it make sense 😤
• SVN::Fs::version() — TODO: what are we even supposed to do with the _p_svn_version_t value it hands back?? no clue bestie 🙈
• SVN::Fs::create_access($username) — returns a brand new _p_svn_fs_access_t object representing $username. $username is presumed to have already been authenticated by whoever called you. so like, trust the caller, ok? 👑

---

👑 _p_svn_fs_t 👑

this is the filesystem object itself, the main character of the whole page:

• $fs->begin_txn($rev) — creates a new transaction in the repository and returns a _p_svn_fs_txn_t object for it. the new transaction's base revision is $rev, which should be a number. 🔢
• $fs->change_rev_prop
• $fs->generate_lock_token() — generates a unique lock-token using $fs. TODO: this needs translating to apply to Perl — apparently it can be used to populate lock->token before calling svn_fs_attach_lock(). 📝
• $fs->get_access() — the filesystem's current access context, as a _p_svn_fs_access_t object. returns undef if no access context has been set with the set_access() method. 🙈
• $fs->get_lock
• $fs->get_locks
• $fs->get_uuid() — the UUID associated with $fs. 🆔
• $fs->list_transactions() — a reference to an array of all currently active transactions in the filesystem. each one is a string with the transaction's ID, and you can pass it straight to "$fs->open_txn()". so convenient 💖
• $fs->lock
• $fs->open_txn($name) — gets a transaction in the repository by name. returns a _p_svn_fs_txn_t object. 🎀
• $fs->revision_prop($rev, $propname) — the value of revision property $propname in revision $rev.
• $fs->revision_proplist($rev) — a hashref with the names and values of all the revision properties from revision $rev. all of them. every last one. ✨
• $fs->revision_root
• $fs->set_access($access) — associates an access context with an open filesystem. you can run this method multiple times on the same open filesystem to swap the access context for different operations. $access should be a _p_svn_fs_access_t object, or undef to disassociate the current access context from the filesystem. 🔄
• $fs->set_uuid($uuid) — associates $uuid with $fs.
• $fs->unlock
• $fs->youngest_rev() — returns the number of the youngest revision in the filesystem. and fun fact: the oldest revision in any filesystem is numbered zero. periodt. 0️⃣

---

🦋 _p_svn_fs_root_t 🦋

roots, roots, roots — here's the whole list:

• $root->apply_text
• $root->apply_textdelta
• $root->change_node_prop($path, $propname, $value)
• $root->check_path($path) — what kind of node is at $path. returns a number matching one of these constants: $SVN::Node::none, $SVN::Node::file, $SVN::Node::dir, $SVN::Node::unknown. 🌈
• $root->close_root
• $root->closest_copy
• $root->copied_from
• $root->copy
• $root->delete
• $root->dir_entries
• $root->file_contents
• $root->file_length
• $root->file_md5_checksum
• $root->fs() — the filesystem $root belongs to, as a _p_svn_fs_t object. 💜
• $root->is_dir($path) — true if there's a node at $path and it's a directory. 📁
• $root->is_file($path) — true if there's a node at $path and it's a file. 📄
• $root->is_revision_root() — true if the root comes from a revision, meaning the contents have already been committed. 💾
• $root->is_txn_root() — true if the root comes from a transaction. 🧾
• $root->make_dir
• $root->make_file
• $root->node_created_path($path)
• $root->node_created_rev($path)
• $root->node_history($path) — TODO: _p_svn_fs_history_t 📝
• $root->node_id($path)
• $root->node_prop($path, $propname)
• $root->node_proplist($path)
• $root->paths_changed() — a reference to a hash showing what changes were made in the root. the keys are the paths of the changed files, starting with / to mean the top-level directory of the repository. the values are _p_svn_fs_path_change_t objects holding info about what kind of changes went down. 👀
• $root->revision_link
• $root->revision_root_revision — the revision number of the revision the root comes from. but for transaction roots? it returns $SVN::Core::INVALID_REVNUM. 💀

---

💫 _p_svn_fs_history_t 💫

• $history->location() — in list context, a list of two items: the path to the node whose history this is, and the revision number in which it exists. in scalar context it gives you just the revision number. pick your fighter 💅
• $history->prev($cross_copies)

---

🎀 _p_svn_fs_txn_t 🎀

transactions, babes:

• $txn->abort() — aborts the transaction. any changes made in $txn get discarded and the filesystem is left unchanged. poof. 💨

note bestie: this function first sets the state of $txn to 'dead', and then tries to purge it and any related data from the filesystem. if some part of the cleanup process fails, $txn and some portion of its data may still be hanging around in the database after this function returns. use "$fs->purge_txn()" to retry the transaction cleanup. don't say I didn't warn you 😭

• $txn->base_revision() — the transaction's base revision number.
• $txn->change_prop($name, $value) — adds, changes, or removes a property from the transaction. if $value is "undef" then the property $name is removed (if it exists). otherwise the property $name is set to the new value. 🔧
• $txn->commit
• $txn->name() — the full name of the revision, in the same format you can pass to "$fs->open_txn()". 🏷️
• $txn->prop($name) — the value of the transaction's $name property.
• $txn->proplist() — a reference to a hash with all the transaction's properties, keyed by name. ✨
• $txn->root() — the root directory of the transaction, as a _p_svn_fs_root_t object. 🌳

---

🧚 _p_svn_fs_access_t 🧚

📜 SYNOPSIS

my $access = SVN::Fs::create_access($username);

my $access = $fs->get_access;
$fs->set_access($access);

my $username = $access->get_username;

$access->add_lock_token($token);

🌟 METHODS

• $access->add_lock_token($token) — pushes a lock-token into the access context. the context remembers every token it receives and makes them available to fs functions. a little collector, honestly 🎁
• $access->get_username — the username represented by the access context. 💖

---

🍓 svn_fs_dirent_t 🍓

an object representing a directory entry. values of this type come back as the values in the hash returned by "$root->dir_entries()". they're like svn_dirent_t objects but with less info — diet dirent energy 🥤

• $dirent->id() — TODO 🙈
• $dirent->kind() — node kind. a number matching one of these constants: $SVN::Node::none, $SVN::Node::file, $SVN::Node::dir, $SVN::Node::unknown.
• $dirent->name() — the filename of the directory entry. 📛

---

🌈 _p_svn_fs_path_change_t 🌈

• $change->change_kind() — the type of change made. a number matching one of these:
  • $SVN::Fs::PathChange::modify — content at path modified. ✏️
  • $SVN::Fs::PathChange::add — path added in transaction. ➕
  • $SVN::Fs::PathChange::delete — path removed in transaction. ➖
  • $SVN::Fs::PathChange::replace — path removed and re-added in transaction. 🔁
  • $SVN::Fs::PathChange::reset — ignore all previous change items for the path (internal-use only). 🚫
• $change->node_rev_id() — node revision id of the changed path. a _p_svn_fs_id_t object. 🆔
• $change->prop_mod() — true if the properties were modified. 🏷️
• $change->text_mod() — true if the text (content) was modified. 📝

---

📄 COPYRIGHT 📄

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

---

and that's the whole page, bestie 🫶 this one came from perl v5.42.3, dated 2026-10-16, and it's the native::Fs(3) manual — go forth and slay your filesystem operations 💅✨👑