মাইএসকিউএল ডক্সিজেন ডকুমেন্টেশন কন্টেন্ট তৈরি করা হচ্ছে

MySQL-এর সোর্স কোডে প্রচুর অভ্যন্তরীণ ডকুমেন্টেশন রয়েছে, যা Doxygen ব্যবহার করে লেখা হয়। এই ডক্সিজেন সামগ্রী https://dev.mysql.com/doc/index-other.html এ উপলব্ধ। এই ডক্সিজেন বিষয়বস্তু স্থানীয়ভাবে একটি MySQl উৎস বিতরণ থেকে তৈরি করা যেতে পারে। নিচে উল্লেখিত ধাপগুলি অনুসরণ করে এটি করা যেতে পারে -

ডক্সিজেন ইনস্টল করুন

প্রথম ধাপ হল Doxygen 1.8.11 বা এর উচ্চতর সংস্করণ ইনস্টল করা। বিতরণগুলি https://www.doxygen.nl/ এ উপলব্ধ৷

এটি ইনস্টল হয়ে গেলে, সংস্করণ নম্বরটি যাচাই করতে হবে। এটি নীচের কমান্ড -

shell > doxygen −−version
1.8.13

PlantUML ইনস্টল করুন

পরবর্তী ধাপ হল PlantUML ইনস্টল করা। যখন এটি Windows 10 এ ইনস্টল করা হয়, এটিকে অন্তত একবার প্রশাসক হিসেবে চালানো উচিত যাতে রেজিস্ট্রি কী তৈরি করা যায়।

একটি অ্যাডমিনিস্ট্রেটর কনসোল খোলা যেতে পারে, এবং নীচের কোডটি কার্যকর করা দরকার -

shell> java −jar path−to−plantuml.jar

উপরের কমান্ডটি একটি GUI উইন্ডো খুলবে, কনসোলে কোনো ত্রুটি ছাড়াই।

একবার এটি হয়ে গেলে, PLANTUML_JAR_PATH এনভায়রনমেন্ট ভেরিয়েবলটিকে সেই স্থানে সেট করতে হবে যেখানে PlantUML ইনস্টল করা হয়েছিল। আসুন একটি উদাহরণ দেখি -

shell> export PLANTUML_JAR_PATH=path-to-plantuml.jar

গ্রাফভিজ ইনস্টল করুন

পরবর্তী ধাপ হল Graphviz ডট কমান্ড ইনস্টল করা।

একবার এটি করা হয়ে গেলে, ডট উপলব্ধতা যাচাই করা দরকার। নিচের কমান্ড −

shell> which dot
/usr/bin/dot

shell> dot −V
dot − graphviz version 2.28.0 (20130928.0220)

মাইএসকিউএল সোর্স ডিস্ট্রিবিউশনের শীর্ষ-স্তরের ডিরেক্টরির অবস্থান পরিবর্তন করতে হবে। এটি নীচের কমান্ড -

shell> cd your-mysql-source-directory
shell> mkdir bld
shell> cd bld
shell> cmake ..

cmake প্রথমে কার্যকর করা হয়৷

ডক্সিজেন ডকুমেন্টেশন তৈরি করুন

পরবর্তী ধাপ হল ডক্সিজেন ডকুমেন্টেশন তৈরি করা। নিচের কমান্ড -

shell> make doxygen

একবার এটি সম্পন্ন হলে, ত্রুটি লগটি পরিদর্শন করতে হবে। এটি doxyerror ফাইলে পাওয়া যায় যা top-evel ডিরেক্টরিতে উপস্থিত। একবার বিল্ডটি সঠিকভাবে কার্যকর করা হলে, উত্পন্ন আউটপুট একটি ব্রাউজারে দেখা যেতে পারে। এটি নীচের কমান্ড -

shell> firefox doxygen/html/index.html