Porting notes / deprecation docs

[Ahmad Samir]

On 10/07/2021 18:00, Frederik Schwarzer wrote:
> Hi,
> 
> as mentioned earlier, I would like to document classes/methods/etc that
> are going to be deprecated during KF6 development.
> 
> For that I scraped up all the deprecation macros from the frameworks and
> edited them to be more unified.
> 

Good work, that must have been a huge task! (82 frameworks ... :)).

> Now I need some opinions.
> 
> For once, there is still some stuff in deprecation from KDE4 times.
> E.g. void setDoScanFile(bool scanFile); from kiowidgets.
> 
> I looked up a few of them in
> https://community.kde.org/Frameworks/Porting_Notes but they are not
> mentioned there.
> 
> Do you think these need to be mentioned in current porting notes as well
> or have they been deprecated for long enough to consider them "over with"?
> 

I would agree, these ones were probably just forgotten after the kdelibs split, and then couldn't be 
removed after the first KF5 release so as not to break BIC... etc. (Others who have been around 
longer will know for sure).

> 
> As for the location, I would probably start putting content in the
> community wiki to a place like
> https://community.kde.org/Frameworks/KF6_Porting_Notes. Does anyone see
> a problem with that? Might is be better to write such docs in markdown
> or restructured text for being better suited for a more modern location?
> 

A wiki page is not most friendly way of editing huge technical documents. Personally, I think a 
markdown file in a git repo would be great, and then it can be "published" to a wiki page or a 
static web page on one of KDE's web sites. Or, we start with an markdown text file, then after it's 
fleshed out / polished, put it in the wiki, editing/adding a small section here or there would be 
easier. (But I do prefer text files, much easier to edit in my usual editor of choice).

FWIW, there is supposed to be a KF6 meeting soon[1]. Not sure if we'll start this week or the next 
one though.

[1] https://mail.kde.org/pipermail/kde-frameworks-devel/2021-July/118028.html

> 
> Thanks!
> 
> Cheers,
> Frederik
> 


-- 
Ahmad Samir