Direct Rendering Manager – nowa dokumentacja

Direct Rendering Manager – nowa dokumentacja

    przez -
    4 248
    Prasa
    Laurent Pinchart, deweloper odpowiedzialny za mobilny sterownik Renesas SH DRM, ukończył właśnie pisanie dokumentacji nt linuksowego frameworka DRM. Direct Rendering Manager odpowiada za bezpieczeństwo oraz zarządzanie zasobami. Składa się z dwóch modułów jądra, które pozwalają na bezpośredni dostęp do sprzętu wszystkim klientom serwera X, z jego pominięciem.

    Dokumentacja jest bardzo dużym krokiem, ponieważ do tej pory była ona tak znikoma, że niewiele osób mogło sobie pozwolić na ulepszanie bądź pisanie nowych modułów. Dodatkowo, aby poradnik nie okazał się po jakimś czasie nieaktualny, powstała propozycja pisania dokładnej dokumentacji do każdej zmiany w API. Jeżeli czegoś takiego nie będzie, nie zostanie to włączone do głównego kodu.

    • Druedain

      „Dodatkowo, aby poradnik nie okazał się po jakimś czasie nieaktualny, powstała propozycja pisania dokładnej dokumentacji do każdej zmiany w API. Jeżeli czegoś takiego nie będzie, nie zostanie to włączone do głównego kodu.”

      Jestem początkującym programistą i byłbym bardzo wdzięczny gdyby ktoś bardziej doświadczony skomentował ten fragment, bo zastanawiam się, czy to jest fajne, czy będzie to tylko bezsensowna strata czasu. Z góry dzięki!

      • marcinsud

        jest fajne. Jeśli ktoś ma po tobie coś poprawiać, nie musi tarcic czasu na analizowanie tego co napisałeś, a i ty sam po paru miesiącach możesz już nie wiedzieć co napisałeś. Komentarze do kodu i dokumentacja to podstawa.

      • Kist

        Ale też bez przesady. Komentarze wstawiamy tam, gdzie to rzeczywiście niezbędne. Jak mamy jakiś skomplikowany algorytm, warto napisać, jak on mniej-więcej działa i jaką ma złożoność. Nie komentujmy bezsensownie każdej linijki, a piszmy samokomentujący się kod.

      • marcinsud

        Zależy w czym się pisze, bo np. w STL'u od Siemensa nie wyobrażam sobie braku komentarzy w czymś większym. Za to w dobrze napisanym kodzie np. w c++ często można pominąć wiele.