[patch] kernel API documentation system

Jeff Garzik (jgarzik@pobox.com)
Sun, 26 Sep 1999 05:41:31 -0400


This is a multi-part message in MIME format.
--------------414E86FF8C4B9FA354D7B53F
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: 7bit

Attached is a simple kernel API documentation system, based on the one
used in GNOME. Documentation, TODO list, two examples, and the
kernel-doc.pl are all included in this patch (diff'd against 2.3.18ac8).

The general idea is to document API functions inside the source code,
and then use the new "make apidocs" target to re-generate the kernel API
documentation. kernel-doc.pl is very flexible and can output DocBook,
man, HTML, and other formats.

The current "make apidocs" command creates
Documentation/kernel-api.html, containing all documentation. Eventually
this system should generate individual man pages, one per kernel API
function, in addition to the existing kernel-api.html file.

Comments welcome. I think this system would be helpful to many.

Regards,

Jeff

-- 
Custom driver development	|    Never worry about theory as long
Open source programming		|    as the machinery does what it's
				|    supposed to do.  -- R. A. Heinlein
--------------414E86FF8C4B9FA354D7B53F
Content-Type: application/x-gzip;
 name="kerneldocs.patch.gz"
Content-Transfer-Encoding: base64
Content-Disposition: inline;
 filename="kerneldocs.patch.gz"

H4sICETo7TcCA2tlcm5lbGRvY3MucGF0Y2gA7Fx5d9u2sv9b/hS4khNL1mY7SxvFcZwmaev7 sp047b1tlLqUCEmsKVLl4qVp7md/vxkAJEhRsrP0nXPPq7tIAgaDwewzoOR6k4noptEL4XtB etFzxv0n4TidyyBxEi8M+s7C67rhOO4lF4mCWQOw0e12r4Oo9i/piidyLG7tit17g50d/Is3 d+9ttNvtK3epHaeBOJYLsXdX7NwZAMGtPay+d2/j8FB0dzo7or3b2d3bFYeHG+2Ndq32PzIK pC+8AJilePTqSLg2cgJS/xwFSRS66ViNdq0/mn0zk+JUoVrCIbxYOGkSdqcykJGT4HyjSxGP I2+RxH21ig7QW/idjfb5zBvPxLkTC2++CCOCnkThXCTY4bsXL58/FYso/E2Ok61YTINwLmmp SMLQ7wnxZoa96P1GOx47QSweizhMo7EU49CVwglcMZOOK6O4wx/CNFmkSVymNxCOOHMiL7nc aIcTMXei03QhJmE0d5J4IMT3b54/6whI4ZswPO1gPhALZyqB1AsmYUfIZNwzfHstzbm9YFri UVxk5NIfc/ZyIUV97pyC/IVHi+rCSZgdSbgQvjyTfrbZv0CztU1JlFdtZdSKMDhikgZjI74Y svAlGPxTmIpxJCFEQMQLOfYc37/sKtZAVuC7xe9xOCd8kORcuh4W+ZfCGYVnksknnDnTwWew EYzZaJudWaDr9WoUhacyEJCOFyQhpBBBQHwW6XtzL5HRoNbf3lYqSgdRJItY/p7KAHRiLJLj cBp4fyi9LOijgBoSqSM59YKA+BJONtpe0K22FpbDt4ZvgTOXevdaTWyL+eUJJHhiTqeMyvXG 4IvahRYQH+i9geqIcy+ZQU/BHTAvmvJusQgj0J2kEdAk0JC4uHUGN6C915DAo4cA3x0IVyqb 1NJgKrwoTjJsUDiMgmMV6/cq18dgLcysjECtqwlRkDQQk6fw45B0yyGNY63IoOepn3iK9RlG a9MiC6yJ/2dMIEBN1JMSEzCUbVEiVU+fz7RzyczfDaFdvSLeWMLSyAnQyzRyFrOY9RRYR74T nFKckj3l/khJ4U39dL0x/C2Ev0oI1hIljfgqMnhvFpl2MtLt6CVeMPZTlyME/JGMIjgi8vWx 3qhvQtGx9rTjGagbwxHHIo3hYhFcPz46VQasYwR/HZsReeMUaQPctY7K5CCtuIxkQMy86czH fwnNqYiVxxp2vgAkZ2reUxhXyYAJG8CIUE46EgoOyTgSiw0Mw7sJAmMa0VKzYBHJiXcB/07Z RpxO1AeiZiQVP6CIE9+ZknKZRQnFNLYeoo6IabZE19L1zacvfjz58dFrDMrgzIvCgDWQUhZn 5MuN9k2YV5xEyNYAot6ALj7XRpuMBMMm2mQKvHBiQ1C2043HL18cv7GhIe0gTpwgyRMcFeZd liMiUyDOdRpiAuU1Uh1bsLstSFEEobGpkcoXWDTVygngqAyz0c6jpTqayidislnJGSk0AOEX CYxYpL5vZ5o5B5BtJiGhZYHstTglUd4IPoVVZ56Sa/LPncuYxFq3Db5OuhfLbiyDGEw5k1mu 9ublk5cw0TixOLPRLqYfM4eM80xGl+Al8tbfU7L3x2TxsYw6oONCeAk0lZKdgOb44OdOxMmK RAZECfT5DDlSKYekxCdVWhanIwCyQRe3h+0GMB8xcsanpBeF/JtWfqczelDnemeemyobUVZH NiakA7PUBm/52FdROIKqIr+OcCgPNiNepz68CBM5w36gH3DPnUtwdCqT3BUSy5Sg4sv5KPSh WeQE6Jjk/J7++9XL129Ojn96/s3LZw+JyKbjuuISaakIzwMcA6cD0+Q8Ri0QyRZA3OVK7zno mHjw+6riMh+LVZwZLVRdtwZ3UHjtqqorr9kqYQG4N9j9Kq/Qbt2727kr2vTyFdVoolaL5qI7 gdVBZ3+dgM9ijjIMrOqLLms7KF9EyH5/vS+GgJ94+J9aQ3KVQUrOXw0U60Yta2hEb5bM/Q2x IeYRhLtA0izGvnQojxzPzFiGVoUA2VfnIjuCS5j0ZqUJaG1Mwp7xwW7v3aOD3b61g/KTT7YB +uYIRUQyTtUrHUf8idItopcL2HFMwOJA9I5/eH5MQtV6PLjm2dq1ynpTdGlWdIMwpoVjcBBR 7NcyQez8trZ7b8ezd1u/ggwGu5Kbrlx0SeQoGc3u81MMMlvpdRXDRK0I7wVe0t/ujYkB+Axf W6Wyk7gPSY37XG56Y4ArvEvjRSVemq4dI/v4J7QUGrp7Z7Bze3B7p6zNFYsKar331WBnN1fr vdtfk/Tp5dau0mvlu8XO/Q3xAcxqc2qIBENVlyeE/QTMhefrmoozkOfCvYQwICjeXjAALeOl h1xxiRc6VC0cuAOFAr4LbgR+QMU3XgzvcozCync50kCFE4diPWGqQfk5x4l9J54B8DFswUDA qrouPNY4CSOP8x7aGkaJrV/JaO7FsYqDEyZYEeoFmAeiJ3LiIHcUCwuQoxGRxlt7E4WMy27J ieqN45Ojb58cvRZNe+/LFuUxN3ZEM5LT1HciXk761tI0IUrg+KCKXxUN7JRzupg9HUb04odn z3hWzURhmPQy1hZzWAw8ZpFQdGKpGJo0v8Emw2PaPcmycO4jqDlGM5M+WEGVNEBZfiY5omiE KO+5LEeaAcTRxAApYcSMpCQRJHGzsDLKKz3SgcJVomAMtjia4zQifgF+56s7d1pEmBJIoVhf FEXNcReYwA3/sms2MmI/soQaRluaAiPXTrmWAZ4i4VCEmJoctPHNcKHSyZvUszsVczkfUXat WWxyIsZyk80IvFGmpCixKR95iVJAHoHGc2BlWju6QAKaKEwTrnWWicKWc9LRnbu3b2eaKFgL SauIg4yimattrlV5OYIPLzKlLGlTB7mVH45N4/B0zh8tpUVSwIUII6YCRKe8onh6sb3kW5qc zHKNIrZJsToUXeVJwi8dCr/4W4VO2VdrQ7xXTu7eVwja7Vt7e53d2zp4n04iKZuubGk31+1v 564ukvPwzCbnWl5MrdK5KjOsQ3VPlr2zG1g+6VqngH0sf8DJPldqh4onofItH+EiBEuXCIWH sFGT4hJPkIEJuDqP2rjsfzOjw7YojHqM4mjCcLEe7IhzqZwiFH3Llb6ETmxx/cTw/aqwWB34 VRirnCuGx0qQ6zTpqxeWsr+7gztfL/Xnv9L9+cY/RD+No/7IC/owWp/ynkaD/lu5BU/y/15G 3hQlARnqVtYn37qql+57o1gnmD1Gc2Sa8Nxf1Yl8QgIMOUGgsxD9ZJn/lGD+d070h3cq9n+b 8pvDRTgKL3ooEQ8y4h+Hi8uIC/HmuEWrvxbPPdggMP+cjsczryMe+b54TSCoC1CxRaTw+k8j +bw/jUT1hMNJck4+cAJuwc0Grow0i34Qr9KRj3TjmTdGAQdX/gqpQUxG6LiVlNC6xy9f/XT0 4jv2gmwuc0re6WqAeg5UwyxRwqLFv4qicw/H5y0csUVCI0TcQaDgyGUVfD5nM7rFzhbCMagB b3Wp+lVaWhlIs40ikRZfJFSNkv/vwpyove2H5+QgFB3iRZjAAzEpYUCePl2QFsRETE+BpDFK vAG9y5VPvBXdM/GOXrKEmj+p9yeMiwcAPKImzZ86AcdrAqrolcrHd4SX/wCbFX6mGVI92Ov1 3gH5mJnVjFsxkmV1vcN1m+Iu1DXRo7oDhINwWz9gjmWE6bqAiQLHiCorewNfaMAgXaYGwzX4 LrgqiqIovvno5v6rdI0x0b2LqXcmgywLwBGwI+yAcIWYj7IpFbE9WGwk3YwKdXISKVfIOI1R HboS4+Al49hAk4FpRkxDBREnLkbUhYMKqGYYH3qZhmq+hZNMsYgEcRSoxkmI4HxOLE2oFdUR TQim9RCZ3zTwJsjORMghgu5gTF+ql4m74o/Xb1vrd4SxqLyxhUjAlBAijq4Nih6GXyfcQhuA iib0fUZVpdXvbD0k8KYKjQBMZHQxQL5S7Ihmc+Ki9bC1rZfYnVaFh1IdOxLSpk+KqAxZ+QLT SFJ3k4N8oECmUNti39ZDSnNYGschNF+1viLvjLqH8kI1rM+5thmxkRb5Mr+0+u40kmE7Ujmk fQBNFMQ55ex1rnpKWq9JL6VqgFHObrGD0DmTRLtS1FGJxUPudE4om1bd8oaQvWlvJZXQaWqA YwgyTycTDXFIlwjRdCAoiZ1zo9GZo1RW0xroib0QzFn4qBuoF6jmzcmhVB0oNLGM+/7INgZf lp4iV69Blr5GZvLIXC1lyFrIfBFB7EYOSJefeXxXej6puA6rxEl3suTsuA6J2N1oj0GyprjD HUXjq3Iz101rQrigK2Dk83AhfIlPXipruiNWOQvqJEXqIthQsZX3uLcKTW5MUZ/7x0evt4p9 buh43ukG1E3lB9jKtwqt6sxBMFxu30WobJihVMd7q7LlrWMf3B9OB5lFUpdRWSefGkdZbOb2 kRX2N9qbNHRi0IkHoj4cDm80h8Pzdqt+38wTD2iOx4dDvLSsWSZXLz0sL9WVipq9WZ4FEzXe 4WY2pc70UsUCkKbbUFRVx4mXpKxvykW/DGTe1C2EUYVE3YKch9EpcikvQsg7lxTAbmRaEJ9w YH0gmqLIi46o73sHw83d/b53UFe3TfSXc4QgRgpitAyhDr4eC3OOQJLkIEe138fHumgRl9h9 kTkZMuv7iwPFJORV07nfESZDMOe2z0YQK84WSVj4WJLSijG8YfxgWFeRcFhXlFgQqxlgzEMt yT6tYYd6R7qs1lifl1ZBP2gJXpxIQau3qzmZ2Y4Czz8uMVTzpq6ADnjlwTAwzOXyYz13GeRv 9laz1zBnFX+T7OILXitJLqmnM50VGUypdyV7h8OgdyTgNeogg1+AOCO6wEIC/eYK0Ix718HL Z+7Vm2+HvWFHvNtuDYOH9aW1m3tmeZkx6lD1jA8Icl1q7hSPzrGv+uybu6vUpWoqP1vFpJEr zZXp1BTUjUuG+1VFlni/0SYU6lak/gMXXmJz5xpl1tn1qi2lJdYeWfL9seXXakxj8yCeLs8K 1Vm+TF54idjFhw9KXKoINve4G21vIpqbjUevv/vxwYPubsvwhhnVbJl1m4hhI2oBP6D7hfZm EJ5oPukBm1N6SFFzwl3aB3RZyjRZOoLRkrEUBIjpotbRrOqkMIOAk54XK1wacWTOqhSLGuRP cGTNTTro25134sF/xLz/S7fZ2271s0Nvjucu4OOZN0nEIYFqJjKTaFL+Luos8jovqpUPyVNY VFt9TAIhiFUH1fO07QeUYXFxb+Ji9daav7WrGFxbz+EV+5J6r9iYp9bvTCDrttbzK/bW1rZi ewqDV2xPIOu21/MrtudAsGJzNbd+d4ZZt70BWCVyVnkiQDS4sxtISckw5Y0qg/ICVBdUInGt QncJVEeYngjtXDCbZf2u2NUYkd4XqThbk85RTbmZd1Bol7Lh7d63R5d2thZwa+N99vmDXryC tjMjjdwrrYE2Lt0ssn3XmmWWRzMri05uaa3tIrDkzz9tdF26mKu3FKbcuzIC7WQ5azMdLSd/ opYbQy49ieIkqpMZL3yPHrW1HsFSTwdZlVFDN+K4dO33BT1x4CR8p7PphvmjWzpCYiUXIZu6 5hTNU3kZ24rMpDesUJTVsGZJvnYzX/bejH5o5VGpQEHvgaAITjeQ3FWFb44HZtWgEtVgGt9X 2D5kPXzhpvNFnD1DlKGD6jpR5FzG/ZkTI2mjxrsMjAUxUxdptAhjqSpoyhMI1YnBpKPD/FJs Fi3o5H4+k1MvfgshmDolXgrEiiFqPcWeYlrUN7qp8G+SbjVqis/Hb548ff1a1LMi19C1tbm7 BeCtbO8txZLapgEFxwgjmVMGtKTxZZo4p1IElUnI+02unKzZ3z5GbTNbdRU5smpP1anNz6ya EpXbaqAV29QWaTwThxqIWrodJdCSGSplMsV43j1RDRlzlA4slPRJ1fG5jzsQ9cITkHWez9Zx JxlAh6alnGMsAsYEdcNmeN6rYkjrHAWEhgk2kEKmUITFJ2sVnMmPdXjLbfP9tTTcgFA4yxRe njl+wdA1YOZpOBI2yZclGlm2hzIHVk+GIhdab9FY7n94Rj0O2rHCKUk616aV8BkoKYbyZ7l7 sj2yVgTytfzck80myv1zDt3gx6oQ/N9vniDH/JAzppnbALbWQmkVvEcaJMVEf3+2d2Cevd/v 44MpPW0Y76De26Rt328ZrSMb3vrQq1PDZql62B8tL1DAo2XgZuatmTydSRdEmOtn8/C9xlvQ 9a0PH5QsKyjOAPn7Flsf3ufoNP1C0ZsN24Qq7VCU/QOW3li/f36Odvt+QS+o9tWaoGVvzbWq uD67dfDIVFAQza0KPru+NfgZ7HKTgy/Isgyryz24Wtncm+VtSltYGYt92H71aY3Pzs9q+ayl k4KNZoXF02w6NVusJNr4OiJZv2eCMxT91CazdIZZdGAlFEXD506bfgy+4AB44os7APrsuZnW 4T1FMnVIlciTyXYrDPm+tQJJVP/tL4+6PzvdP3a69971u/3pkibDG/JTJBUajCnQ61TP8KLE S3x5sL+YRXSB77kPhnXsPKyvcjEK8IA6hzaC5Q36a/fmZ2m8s+VJYWZXEWCmq1fqJLBiVuT2 p2AIXQWS/jos2fY57UtHiy+DcBF78YrjKX4da6D9/gr+CcFtV4OsCkBBIIlbHT9Emf68eVvF 3SXwvNmr3tJmefe0dG4YxK6ebVz7yI0rz9z4pEM3PvLUjeseuzKWqgbcqmggDgCpHOUnRJHS 8RmocP518aQUJYXVO8+h7Ba6fp+fOAupeTqWi+ss9NyV7hjz/fU6zOa0bC+NJRBLtRSChp63 M+8V+mj0z4r2qxTQXA9koDnF15ZwxmlzG0sghpefK35CSrPG35NCYMH84BpyZThNR0mnCCV9 90NhFPYticq58qz7gWpeZ1Ofkn2Uthf6ckYdp18gZr9fOnG9lO8riDKjVyjsfrbPizCQpBp9 66hVSdFa5aPvH7M4dS6gnUOJWZ+ZUlVocp5iGUUuiKxRK6mzgbdzbkME9wye/vvR81fPnva9 JZXb18/NFG7OmP8fm8HlVCmefzwp+gqvb0iqVAZN5pLktHAL4h0GdvvpOrmiuk/8b04WiZK9 lXnJNRJA23eWvKf6HgPt8NFpwH9V5vN3CvCZKUAxwK9Vm4+I/6t18TopwHXl11gb4RufIN7G XxLjGx8R5Btronzjk8N843PjfIMUr7E+0jeqG89XxfqG1tUrNPEzlOrTkkZ9++PzXZpYTM89 V8Ij7w7rYkKr8T6g49RFFPr0iZHG9DhPsdWSTKMwXYhx6NNDP3vLADSzkGOCwCbJjKC2rwX2 dQVYMgrdyy+W5Ubh+cG+/mYM1C3ApvzNCOx7DSMopIolI1ia+8tTW7Uj3BjOVJmxKNbhlSWG NwUd+AIJ7ZU6/n+e01ba0XJW+xcms1E4hdjYBQXTTC45gy0RFTLfL5L1Foc+5SD90gGWk+LK o4gK8VclxgDTaeLS/WyeJM+doJAb00NTXzQzLpDUe/O9QGZazInhBrOxPJvj0fxLWF/zZ3rK 6LkTpI6Pj+rn3Sr6d73j74W5r6maPgKmlSnncLmdSA/91SsTzgrgpnW1/uUua4o0r797IKIM ydblg6H1C97WlBLLK69rSDAVXZnPYcur6/NFlPkhdveucAjXvH35NAdK3IDiG09Y/0TntPLC nL41Jy+Sgnnzs5GfZd8FgX6bP1BUbR/LVZ/+bQSS0ECstsLgS6iH+ETNKGRFREL3oALVsuGV 66dP04sMfFBNyJdREv3rFuWnK+gXKfirovx9e/WLUoEUIyemr9036Jux+uvMZiU9gNcrKFmG yzylZF3SNw9PDD38VEJdz4G91gN9PbhRArRvAZnqxDnlH2bItsh+wkh9h3RBz97xLwr6Ph/B lYnj+bH67ih9p1B/mVRM/XCE/c3zSLEz49+7yB45sg9hYlq+WeHBI6tMsCD4sdZmq/nW6f7x qPvzTvfeyX8G79qtYbw9bDbf/jJs0QPfrb7483+Lu7rfpmEg/hz+iqzNln6tYdtbS1mmgVAf KBJ74GHZqm0po2IkUwtMCMbfju/LPidZAYFgmrTWOdsX+3wf1u9u3xCaU+0JOSzZuv8n/YG0 Bx3+bJD+X2Gl/1sMdUOCYZG6mPOiRz6OcS7opn1sZmUWHeCeBLBj7y4+LxzGsOMP9z1Mskt6 mF0mpNykdgvhsSw+cWfHGwuDBE2p8YiGdqtKXAdTHb1+cYLYKeA6FmPpoi4oZMaInHgQD+gi 0ZlkEOfVEmqkYjWX5OPqYnlDOWsXV4u1GG4YBa8Uz80CJ8m41m6aI2zXcb7weHJ8NAsNoyNi M1YRV8qLjRx24mzNLMrL1gcD3YW9dNwmCV+35S09HP96ZzpwNADLWa/fdTjyILDDk4Aw7AyG GbAosV50ORkWUgVgFOGoNiFD6PDzPUOi9JT+8wmATjH3niq+5eHubosY8l7yDZU2I6BVUXZH 1otV6aUxjRp7NeRQq8X+udC7dW/fgZbAs5oD3gZ/U6yxVK+BK/TgBstiC4dccBAa0Kz/5BpS hnkO2dlqDQDaal4VSxcAlDJ3Oh/k0n6R8elYVmMi3DsPFT2ZPAZgcG7C4WKRdx5EQONi3jNc uGLhOsrdAWCf3wlTZIJQAh0kcPBveeq5PkijlJQQ+W4OUGWVTawSrolqW+EkqyTkC1XIsFFI tZdCk2rMpk8kI8lXOx0DNfz14VaiaXBR/sYP5bMuCzL+UN0IPj2G9Fe8mkEsNzTtQWGBsnwv WcAebBQI9qGYhM0TXi5uchhw9REhpwf6oS6piFbBJurYWwHJg4ry8moudTEhqzXNtrMo29FP YRJ4dp5kWQ9+I8yrybH0TU65sL3Etl2VnD27RmLzxz7ixFshG1IGbnd0aCmAQZ/i1Hhlislh 6+zw1PQKjb0egZ5V8yJY1O/NBI/62xYEDTYY9npbg2upKa0Ac5nQwWaZzAPbUpthQiFicXVl tedcCQvaVY56axy0pUiWuyNTW1TtT7OQTuINtZYaK5h0MJXC5i+ButkqbxdFZzobtJ4gjaQc NKi7EVRhAy0HXagkSuSSx4JCJeXQH06iejKdPWW8OvGGMbq9hyLxs/fTwljiZCspxW6JrO6N A7M2MCOWOqBiwVj+0yvaSyfD2k+HYbeTQgZb0KbyXzJSbYiwQ4N3a+wBmeNOZa6Q4XYMk2nH jrva+KMpq+ob11/ZnwdJW2Sl72UCyXJRM/ibOS3elsp0nYhWgAIyoFjsJLyxgfgempuKU3D0 eqaGPK5Zw2geYuVQs8JMRrmZxmcKp1Au7hMEccaNvMOCq8AKkAkHnpLatJ/7tJ83nMKMtTNG OBT/wwGu+CjpHnWBM0fK7WixuFPHjffUNKqTjF6brP0WXlq5vBT0aKOkq/ZCp4rYW1gNZR/b zd540nFbkB/NjOJt/BtMuefDiQDbWaQ0F245xlok3OoZdU+S/V8WxH8TfTKafUEwTuVbFDau pDPwLKw1k1YMdWzdqojmwQNrwgzJiTfWfnn9aXGzS1Wi5D80vDdSeb0YOMl1hVzWVMaFOjsL RKcJ6gNhZZ4vZOzxhZwNsUphjwIAjBG9q//zNPmnm1HVaFryor1ha5PSaYdLs1uwWkV5ZzTH 5UWOq3AYcjGmYbNqms5eKO0kvUZGK7XG4WaFckAKxau/4m5dwg7LkBUMbSM+tCGeNS7Ouv/y 6PjZq2Pztb0snZ2DCDnHQtvvzNiVSE+ECO4bvp7peNEK4XDSECFip+xrAznE0qnhZ9g7NP5Y ml6Xa3AxKEZXtaTqnU6zVVac9dMQ+9i4HmptgoAmV6u4ueN52E/9Prayq1wBBN5Nlrqd4rsO z66yFNWdNdNWd9d0I4YM7kGzJ2c6VH05Q9rgzTXpgg2GygscfgBCnbzg12gAAA== --------------414E86FF8C4B9FA354D7B53F--

- To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.rutgers.edu Please read the FAQ at http://www.tux.org/lkml/