From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mail-ed1-f66.google.com (mail-ed1-f66.google.com [209.85.208.66]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id A1B6836895A for ; Thu, 26 Feb 2026 17:02:08 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=209.85.208.66 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1772125330; cv=none; b=poPFoGx/1CZFCP7EuSfloCTjjZAD6Af4j2xuDErCvVCrYM9lipU6P0gi85Ym0UbIAANQ+mjtWEfoIMB3BKC7Ch8PuyWNgdGqWdEiY1NmSvfRTQfVp2uG68kmUzqGoNKaS1c+oNzFHZ5JRby7NfKOxcWuNzGRPILqGy4HchJytoE= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1772125330; c=relaxed/simple; bh=gEY8vDHEeT/o0NuKGwlPFL4lqOpMv2OnYYUAsD6wBP0=; h=From:To:Cc:Subject:Date:Message-ID:MIME-Version; b=YqvlMpHChL0DDMOXKsY23QDuWbskjA4snkqQZeqrh2cnJ3lpOzoyjyHUjlUaI+LNr08irHm44ugqwgMzYRm9zG+NNPnEq4QTgIMdRXsVQ9+RBDmzEiErQNIWz52UNtjG3YkTLPTegGUyqV/zELznlfsBOWVpSUklvrzjM5fgeaQ= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=permerror header.from=versity.com; spf=pass smtp.mailfrom=versity.com; dkim=pass (2048-bit key) header.d=versity.com header.i=@versity.com header.b=ECW8FcVt; arc=none smtp.client-ip=209.85.208.66 Authentication-Results: smtp.subspace.kernel.org; dmarc=permerror header.from=versity.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=versity.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (2048-bit key) header.d=versity.com header.i=@versity.com header.b="ECW8FcVt" Received: by mail-ed1-f66.google.com with SMTP id 4fb4d7f45d1cf-65fb991d7e7so1347315a12.1 for ; Thu, 26 Feb 2026 09:02:08 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=versity.com; s=google; t=1772125327; x=1772730127; darn=lists.linux.dev; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:from:to:cc:subject:date:message-id:reply-to; bh=MGeAfEVhQHYlO2DJEJDIZa0CLDLPlvbPeeKHPSRz6wI=; b=ECW8FcVtV379X3+GJmNb6vzNLflBLO9c4SJyLTjqw8Iw+7+0cCjXrmLupLNhavEl1w 8s2orZdwjurUQbe+4NQPqTkaXx8GPW2YJtlCmCJHmjC+8ELlnev8Z8KaY1HTvJzyPq2X NKD+k+PY7oYjTq1HiZ26wvFKcQkBnbC8bBrcZMplPHN6jxSbojKhWZA21IxzbjImsPUR IC9M1bMfXX1DRydTX+969i4Sokdx9i8IHdpGuwMLuBTgInhkt6I9H2my6iWOrqQKMGmH MBK7/tlOtQHuY/F5mR084ZuPkF6MtkmThiLn+IVZ678KZdq8Dbvzs5OMl6RZFa6LoZvU 0nIw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1772125327; x=1772730127; h=content-transfer-encoding:mime-version:message-id:date:subject:cc :to:from:x-gm-gg:x-gm-message-state:from:to:cc:subject:date :message-id:reply-to; bh=MGeAfEVhQHYlO2DJEJDIZa0CLDLPlvbPeeKHPSRz6wI=; b=ur+KD4Gyt6rVsG7K9n38jaG3XNJf/P00Qd3n7IXyYW7kqOnV4gVuEpVlSMddh1mNPa vrqLC1KsKPE6i6cdaUhXwEZXtOlRmRzIo8EqRpEKSYIJfvGSSynWhZn681nVvdg0yUxZ v22YKJIwLeMP8rt8+PZi90UbinatEPGdWopiIbhonz+efBCi5CReRflp4boXW1hTryKs lS43fGb81J4GzjLfDoWAgIAFg4PCzlACuH2U3IX4GIgcT3XwDYBB5DrsywqoNTcdNSJ4 5Cjx0p/6aH7pMMkEAUsb9lzCg4wA4j8giDz4IAUg3g0nrrXmGQrpjbR6EMR3pcqqAqgl L6uw== X-Gm-Message-State: AOJu0YwcAfucBkLJEAl16Z3yvR/OwfdDP7kLhYnb7+OUA6zBUTEcjZ7m j57OFeuC71HhpKYScPAVm52O+kyIMSw1o8ovIZfOryfkQ+iODt4ZGMxRRK/e0NIOqFluqQjzkCR Nz9dsQGI= X-Gm-Gg: ATEYQzzHUXrUix4r2oHKZWx7JJDc6zZ5bBJUew4JZGf3TYRJ7hrqTeudN5XkRCbG0l7 A4SfSWUFpAGjnqcuV/aXN7791U7mIXCcLIqzAAJc+5WuupIsg2Szsrw2ga7/eslaBQrPsyJIVY5 Y+EQKrSZDppRidWQfAvbVScA03PJb5YJtKkl0wtsrBX+vv4vcx9yxY2MVLHffe4V9F6dFSEX7NE KUfddzJ9ipZzlvadGCgej84kMK5H5gMDbQrykbB07uJ6FaG7j7AWV8nEMoY9mLUowM0tArd7jrw lWZ5k3x/rVUZsCHtTVYRWwOZC4nia8U1y/ywNSQ1hhN5pkGmYOoTLWC0FS3NLi4H9CfsZO83FBG +oK1gOMAtAKB5DcHL8dK1NuZQcTdCk1FrLYCKzEcodjpX4nH3b3p7dYrilkAO+CYkq9GiBt5twr PAUgPren/H8PjIK5Mdp2OgQSJg4GQgDdkGqsZaXbrbu65mqBZv3afhSYfUnNWKlhjJxnI= X-Received: by 2002:a05:6402:42c7:b0:659:454b:7167 with SMTP id 4fb4d7f45d1cf-65fa47b608emr3313704a12.23.1772125325002; Thu, 26 Feb 2026 09:02:05 -0800 (PST) Received: from localhost.localdomain (46-117-212-87.ftth.glasoperator.nl. [87.212.117.46]) by smtp.gmail.com with ESMTPSA id 4fb4d7f45d1cf-65fac06dc16sm652542a12.23.2026.02.26.09.02.03 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 26 Feb 2026 09:02:04 -0800 (PST) From: Valerie Aurora To: rpdfs-devel@lists.linux.dev Cc: Valerie Aurora Subject: [PATCH] Update documentation Date: Thu, 26 Feb 2026 18:01:53 +0100 Message-ID: <20260226170153.17863-1-val@versity.com> X-Mailer: git-send-email 2.49.0 Precedence: bulk X-Mailing-List: rpdfs-devel@lists.linux.dev List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Signed-off-by: Valerie Aurora --- docs/development.md | 18 +++++------------- 1 file changed, 5 insertions(+), 13 deletions(-) diff --git a/docs/development.md b/docs/development.md index df606b4..429171f 100644 --- a/docs/development.md +++ b/docs/development.md @@ -25,9 +25,7 @@ Example invocation: In another terminal: ``` - $ ./cli/rpdfs-cli debugfs -d 127.0.0.1:8081 -t /tmp/trace_debugfs - <1> $ mkfs - <1> $ stat + # mount -t rpdfs -o mkfs 127.0.0.1:8081 /mnt ``` ## Code Layout @@ -43,18 +41,12 @@ This is all the code that's shared by each utility. It's not a proper library in that it doesn't need to remain API compatible with external builds over time. -There's two kinds of shared code. There's code that can run in either -userspace or the kernel (block.c) and shared code that only runs in -userspace (options.c). It'd probably be worth making this distinction -more apparent. - **shared/lk/** -This is for userspace implementations of kernel interfaces. This both -lets us use reasonably stand-alone kernel interfaces (list.h) in -userspace as well as share rpdfs code with the kernel module by -providing implementations of more complicated runtime services (RCU hash -tables, work queues). +This is for userspace implementations of kernel interfaces. This lets +us use reasonably stand-alone kernel interfaces (list.h) in userspace +by providing implementations of more complicated runtime services (RCU +hash tables, work queues). **shared/format-{block,msg,trace}.h** -- 2.49.0