Basic File System

Contents

• Introduction
• Reading the document
• Checkout The Repo
  • How to upload the key?

Introduction

This is a book on how to write a file system in Linux Kernel. The purpose of the file system is to demonstrate how easy it is to code a file system.

Reading the document

1. Checkout the Repo. See :ref:`checkout_repo-label`.
2. Install sphinx using the command pip install -U Sphinx.
3. Install rst2pdf for reading this document in pdf. Run rst2pdf README.rst. Read the pdf as README.pdf
4. Use ./hh file to read the html version of the document. Alternatively make html make html. Open the document _build/html/index.html.
5. Use ./pp file to read the PDF version of the doucment. Alternatively make pdf make latexpdf. Open the document _build/latex/BasicFilesystem.pdf

Checkout The Repo

1. Make a github account.
2. Upload your ssh keys for passwordless authentication. Read the document for understanding how to upload ssh keys. See :ref:`upload_ssh_keys-label`.
3. Checkout the code from git@github.com:abrrba/bfs.git.

How to upload the key?

1. Do "ssh-keygen" keep pressing enter.
2. At the end of the command do "cat .ssh/id_rsa.pub" and copy the text from "ssh-rsa" to end.
3. Then in https://github.com/settings/profile page go to SSH Keys (direct link is https://github.com/settings/ssh") and upload your keys.